Submódulos
- xdk.webhooks.client module
- xdk.webhooks.models module
Conteúdo do módulo
Este módulo fornece acesso aos endpoints webhooks da X API e serve como o principal ponto de entrada para toda a funcionalidade relacionada a webhooks.class xdk.webhooks.WebhooksClient
Client para operações de webhooks
Parâmetros
Client
__init__
Parâmetros
Client
create
Create webhook
Creates a new webhook configuration.
body: Request body
:returns: Response data
: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"
A comma separated list of Tweet fields to display.
str or None
default:"None"
A comma separated list of fields to expand.
str or None
default:"None"
A comma separated list of Media fields to display.
str or None
default:"None"
A comma separated list of Poll fields to display.
str or None
default:"None"
A comma separated list of User fields to display.
str or None
default:"None"
A comma separated list of Place fields to display.
Retorna
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: Request body
:returns: Response data
:rtype: CreateWebhookReplayJobResponse
Parâmetros
CreateWebhookReplayJobRequest
delete
Delete webhook
Deletes an existing webhook configuration.
Parâmetros
Any
The ID of the webhook to delete.
Retorna
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.
Retorna
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.
Retorna
GetResponse - Response data
get_stream_links
Get stream links
Get a list of webhook links associated with a filtered stream ruleset.
:returns: Response data
:rtype: GetStreamLinksResponse
Retorna
GetStreamLinksResponse
validate
Validate webhook
Triggers a CRC check for a given webhook.
Parâmetros
Any
The ID of the webhook to check.
Retorna
ValidateResponse - Response data