Skip to main content

​
WebhooksClient

The WebhooksClient provides methods for managing webhook configurations and stream links.

​
create

Creates a new webhook configuration. 
from xdk.webhooks.models import CreateRequest

response = client.webhooks.create(
    body=CreateRequest(
        url="https://example.com/webhook",
        description="My webhook endpoint"
    )
)
​
body
CreateRequest
Request body containing webhook configuration details.
​
CreateResponse
object
Response containing the created webhook configuration.

​
get

Get a list of webhook configs associated with a client app. 
response = client.webhooks.get(
    webhook_config_fields=["id", "url", "created_at"]
)
​
webhook_config_fields
List[str]
A comma separated list of WebhookConfig fields to display.
​
GetResponse
object
Response containing webhook configurations.

​
validate

Triggers a CRC check for a given webhook. 
response = client.webhooks.validate(
    webhook_id="1234567890"
)
​
webhook_id
str
required
The ID of the webhook to check.
​
ValidateResponse
object
Response containing validation results.

​
delete

Deletes an existing webhook configuration. 
response = client.webhooks.delete(
    webhook_id="1234567890"
)
​
webhook_id
str
required
The ID of the webhook to delete.
​
DeleteResponse
object
Response confirming the webhook was deleted.

Build docs developers (and LLMs) love

Get started for freeTalk to us