Skip to main content
GET
Python

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

webhook_id
string
required

The ID of the webhook to retrieve.

Response

Successfully retrieved webhook

The webhook object represents an outbound webhook subscription.

object
enum<string>
required

The object type, which is always webhook.

Available options:
webhook
id
string
required

The webhook identifier.

url
string
required

The destination URL for webhook deliveries.

events
enum<string>[]
required

The subscribed event types. Currently delivered events include knowledge.processing.completed, batch_prediction.completed, batch_prediction.failed, batch_prediction.expired, and batch_prediction.cancelled.

Available options:
knowledge.processing.completed,
batch_prediction.completed,
batch_prediction.failed,
batch_prediction.expired,
batch_prediction.cancelled
enabled
boolean
required

Whether delivery is enabled for this webhook.

created_at
string<date-time>
required

The ISO string for when the webhook was created.

updated_at
string<date-time>
required

The ISO string for when the webhook was last updated.