For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
Admin
Types
Objects
HttpsWebhook
OBJECT
Copy page
An https webhook.
Fields
destination
String
Required
URL must be active, return a 200 response, and be served on port 443.
headers
list of
HttpsWebhookHeaders
Required
You can pass custom headers to validate webhooks being returned.
Show 2 fields
clientId
String
Required
ID of client application owning the webhook.
eventFilters
list of
WebhookEventFilters
Required
Event filters for webhook.
Show 1 field
id
String
Required
The ID of a webhook object.
scope
String
Required
The scope of the event subscription.
status
WebhookStatus
Required
The status of a webhook.
Allowed values:
ACTIVE
DISABLED
INACTIVE
createdAt
Datetime
Optional
The date and time of webhook creation.
updatedAt
Datetime
Optional
The date and time of the last webhook update.
Referenced by
Fields
CreateHttpsWebhookResult.webhook
UpdateHttpsWebhookResult.webhook
