Overview Use Cases Connectors Authentication Getting Started with the Python SDK API API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps mcp_server_connections model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project project_scopes python_function refresh routellm secrets streaming streaming_connectors upload user webhooks createDeploymentWebhook deleteWebhook describeWebhook listDeploymentWebhooks updateWebhook API Classes API Inputs Documentation Chat Bot API Search How to

Method

describeWebhook GET

Copy GET

Describe the webhook with a given ID.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	webhookId	str	Unique string identifier of the target webhook.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY

TYPE

DESCRIPTION

success

Boolean

true if the call succeeded, false if there was an error

result

Webhook

KEY	TYPE	Description
webhookId	str	Unique identifier for this webhook.
deploymentId	str	Identifier for the deployment this webhook is attached to.
endpoint	str	The URI this webhook will send HTTP POST requests to.
webhookEventType	str	The event that triggers the webhook action.
payloadTemplate	str	Template for JSON Dictionary to be sent as the body of the POST request.
createdAt	str	The date and time this webhook was created.

Exceptions:

TYPE	WHEN
DataNotFoundError	`webhookId` is not found.

Language: