v1

latestOpenAPI 3.1.02026-07-2631111195.5 KB

Connection Webhooks

Create a connection webhook

Register an HTTPS endpoint to receive signed events for connections managed by the caller's partner (HQ) account. The signing secret is returned ONCE in this response and never again. Store it securely.

post/connections/v1/webhooks

Request body

event_type'connection.expiry_scheduled' required

connection.expiry_scheduled - Expiry Scheduled

callback_urlstring uri required

HTTPS URL that signed events are POSTed to.

Response

Created. Includes the signing secret (shown once).

idstring uuid required

Unique webhook identifier (UUID).

event_type'connection.expiry_scheduled' required

connection.expiry_scheduled - Expiry Scheduled

callback_urlstring uri required

HTTPS URL that signed events are POSTed to.

is_activeboolean required

Whether the webhook is active. Inactive webhooks do not receive events.

created_atstring date-time required

ISO 8601 timestamp when the webhook was created.

updated_atstring date-time required

ISO 8601 timestamp when the webhook was last updated.

secretstring required

Standard Webhooks signing secret (whsec_…). Shown once, at creation.