For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Get Started Concepts Products Guides UI Components API Access

API Reference Webhooks

Retrieve Webhook Registration

GET

https://host.com/v2/webhooks/registrations/

GET

/v2/webhooks/registrations/

$ curl https://host.com/v2/webhooks/registrations/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": "string",
3   "webhook_name": "string",
4   "endpoint": "string",
5   "status": "string",
6   "failures": 1,
7   "last_failure": "2024-01-15T09:30:00Z",
8   "partner_id": "string"
9 }

Register a new Webhook and Get all Registrations

Was this page helpful?

Register Webhook Listener

Get Started Concepts Products Guides UI Components API Access

API Reference

Authentication

AuthorizationBearer

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

Response

idstring<=250 characters

webhook_namestring<=250 characters

endpointstring<=250 characters

statusstring<=250 characters

failuresinteger

last_failurestringformat: "date-time"

partner_idstringRead-only