Skip to content
WebhookEndpointObject

A partner-registered URL that receives signed deliveries for a chosen subset of the domain event catalog — the same event keys that drive journey triggers. Each endpoint has its own rotatable HMAC signingSecret used to sign deliveries.

Fields

idID!webhooks:write
urlURL!webhooks:write

Destination URL deliveries POST to.

descriptionStringwebhooks:write

Owner-facing label for the endpoint.

subscribedEventTypes[String!]!webhooks:write

Catalog event type keys this endpoint receives.

signingSecretString!webhooks:write

Per-endpoint HMAC signing secret (whsec_…). Verify the Sessions-Signature header against HMAC-SHA256(secret, "{timestamp}.{body}").

statusWebhookEndpointStatus!webhooks:write
apiVersionString!webhooks:write

Payload schema version this endpoint receives, e.g. 2026-06-01.

createdAtDateTime!webhooks:write

← Back to the reference

WebhookEndpoint