WebhooksClient

​

Submódulos

• módulo xdk.webhooks.client
  • WebhooksClient
    • WebhooksClient.__init__()
    • WebhooksClient.create()
    • WebhooksClient.create_stream_link()
    • WebhooksClient.create_webhook_replay_job()
    • WebhooksClient.delete()
    • WebhooksClient.delete_stream_link()
    • WebhooksClient.get()
    • WebhooksClient.get_stream_links()
    • WebhooksClient.validate()
• módulo xdk.webhooks.models
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • CreateStreamLinkResponse
    • CreateStreamLinkResponse.model_config
  • CreateWebhookReplayJobRequest
    • CreateWebhookReplayJobRequest.model_config
  • CreateWebhookReplayJobResponse
    • CreateWebhookReplayJobResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • DeleteStreamLinkResponse
    • DeleteStreamLinkResponse.model_config
  • GetResponse
    • GetResponse.model_config
  • GetStreamLinksResponse
    • GetStreamLinksResponse.model_config
  • ValidateResponse
    • ValidateResponse.model_config

​

Contenido del módulo

Este módulo proporciona acceso a los endpoints de webhooks de la X API y sirve como punto de entrada principal para todas las funcionalidades relacionadas con webhooks.

​

class xdk.webhooks.WebhooksClient

Cliente para operaciones con webhooks

​

Parámetros

path.client · Client

​

__init__

​

Parámetros

path.client · Client

​

create

Crear un webhook Crea una nueva configuración de webhook. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateResponse

​

Parámetros

body.body · CreateRequest

​

create_stream_link

Crear enlace de stream Crea un enlace para entregar eventos de FilteredStream al webhook indicado.

​

Parámetros

path.webhook_id · Any

El ID del webhook con el que vincular tu conjunto de reglas FilteredStream.

path.tweet_fields · str or None · predeterminado: "None"

Una lista de campos de Tweet, separada por comas, que se mostrarán.

path.expansions · str or None · predeterminado: "None"

Una lista de campos que se expandirán, separada por comas.

path.media_fields · str or None · predeterminado: "None"

Una lista de campos de Media, separada por comas, que se mostrarán.

path.poll_fields · str or None · predeterminado: "None"

Una lista de campos de Poll, separada por comas, que se mostrarán.

path.user_fields · str or None · predeterminado: "None"

Una lista de campos de User, separada por comas, que se mostrarán.

path.place_fields · str or None · predeterminado: "None"

Una lista de campos de Place, separada por comas, que se mostrarán.

​

Valor devuelto

CreateStreamLinkResponse - Datos de la respuesta

​

create_webhook_replay_job

Crear trabajo de repetición para webhook Crea un trabajo de repetición para recuperar eventos de hasta las últimas 24 horas para todos los eventos entregados o cuyo intento de entrega se haya realizado al webhook. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateWebhookReplayJobResponse

​

Parámetros

body.body · CreateWebhookReplayJobRequest

​

delete

Eliminar un webhook Elimina una configuración de webhook existente.

​

Parámetros

path.webhook_id · Any

El identificador del webhook que se va a eliminar.

​

Valores de retorno

DeleteResponse - Datos de la respuesta

​

delete_stream_link

Eliminar enlace de stream Elimina un enlace entre los eventos de FilteredStream y el webhook indicado.

​

Parámetros

path.webhook_id · Any

El ID del webhook que se vinculará a tu conjunto de reglas de FilteredStream.

​

Devuelve

DeleteStreamLinkResponse - Datos de la respuesta

​

get

Obtener webhook Obtiene una lista de configuraciones de webhook asociadas con una App cliente.

​

Parámetros

path.webhook_config_fields · List or None · predeterminado: "None"

Una lista separada por comas de campos de WebhookConfig que se mostrarán.

​

Devuelve

GetResponse - Datos de respuesta

​

get_stream_links

Obtener enlaces de stream Obtiene una lista de enlaces de webhook asociados a un conjunto de reglas de un stream filtrado. :returns: Datos de la respuesta :rtype: GetStreamLinksResponse

​

Devuelve

GetStreamLinksResponse

​

validate

Valida el webhook Activa una comprobación CRC para un webhook determinado.

​

Parámetros

path.webhook_id · Any

El ID del webhook que se va a comprobar.

​

Devuelve

ValidateResponse - Datos de la respuesta