Submódulos
- xdk.webhooks.client module
- xdk.webhooks.models module
Contenido del módulo
This module provides access to the webhooks endpoints of the X API and serves as the main entry point for all webhooks-related functionality.class xdk.webhooks.WebhooksClient
Cliente para operaciones de webhooks
Parámetros
Client
__init__
Parámetros
Client
create
Create webhook
Creates a new webhook configuration.
body: Cuerpo de la solicitud
:returns: Datos de respuesta
:rtype: CreateResponse
Parámetros
CreateRequest
create_stream_link
Create stream link
Creates a link to deliver FilteredStream events to the given webhook.
Parámetros
Any
The webhook ID to link to your FilteredStream ruleset.
str or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
str or None
default:"None"
Una lista separada por comas de campos para expandir.
str or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
str or None
default:"None"
Una lista separada por comas de campos de Poll a mostrar.
str or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
str or None
default:"None"
Una lista separada por comas de campos de Place a mostrar.
Devuelve
CreateStreamLinkResponse - Response data
create_webhook_replay_job
Create replay job for webhook
Creates a replay job to retrieve events from up to the past 24 hours for all events delivered or attempted to be delivered to the webhook.
body: Cuerpo de la solicitud
:returns: Datos de respuesta
:rtype: CreateWebhookReplayJobResponse
Parámetros
CreateWebhookReplayJobRequest
delete
Delete webhook
Deletes an existing webhook configuration.
Parámetros
Any
The ID of the webhook to delete.
Devuelve
DeleteResponse - Response data
delete_stream_link
Delete stream link
Deletes a link from FilteredStream events to the given webhook.
Parámetros
Any
The webhook ID to link to your FilteredStream ruleset.
Devuelve
DeleteStreamLinkResponse - Response data
get
Get webhook
Get a list of webhook configs associated with a client app.
Parámetros
List or None
default:"None"
A comma separated list of WebhookConfig fields to display.
Devuelve
GetResponse - Response data
get_stream_links
Get stream links
Get a list of webhook links associated with a filtered stream ruleset.
:returns: Datos de respuesta
:rtype: GetStreamLinksResponse
Devuelve
GetStreamLinksResponse
validate
Validate webhook
Triggers a CRC check for a given webhook.
Parámetros
Any
The ID of the webhook to check.
Devuelve
ValidateResponse - Response data