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: