Skip to main content

​
Submodules

​
Module contents

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

Client for webhooks operations

​
Parameters

​
path.client
Client

​
__init__

​
Parameters

​
path.client
Client

​
create

Create webhook Creates a new webhook configuration. body: Request body :returns: Response data :rtype: CreateResponse

​
Parameters

​
body.body
CreateRequest
Create stream link Creates a link to deliver FilteredStream events to the given webhook.

​
Parameters

​
path.webhook_id
Any
The webhook ID to link to your FilteredStream ruleset.
​
path.tweet_fields
str or None
default:"None"
A comma separated list of Tweet fields to display.
​
path.expansions
str or None
default:"None"
A comma separated list of fields to expand.
​
path.media_fields
str or None
default:"None"
A comma separated list of Media fields to display.
​
path.poll_fields
str or None
default:"None"
A comma separated list of Poll fields to display.
​
path.user_fields
str or None
default:"None"
A comma separated list of User fields to display.
​
path.place_fields
str or None
default:"None"
A comma separated list of Place fields to display.

​
Returns

CreateStreamLinkResponse - Response data

​
delete

Delete webhook Deletes an existing webhook configuration.

​
Parameters

​
path.webhook_id
Any
The ID of the webhook to delete.

​
Returns

DeleteResponse - Response data Delete stream link Deletes a link from FilteredStream events to the given webhook.

​
Parameters

​
path.webhook_id
Any
The webhook ID to link to your FilteredStream ruleset.

​
Returns

DeleteStreamLinkResponse - Response data

​
get

Get webhook Get a list of webhook configs associated with a client app.

​
Parameters

​
path.webhook_config_fields
List or None
default:"None"
A comma separated list of WebhookConfig fields to display.

​
Returns

GetResponse - Response data Get stream links Get a list of webhook links associated with a filtered stream ruleset. :returns: Response data :rtype: GetStreamLinksResponse

​
Returns

GetStreamLinksResponse

​
validate

Validate webhook Triggers a CRC check for a given webhook.

​
Parameters

​
path.webhook_id
Any
The ID of the webhook to check.

​
Returns

ValidateResponse - Response data