Sign in
Webhook Subscriptions

Create webhook subscription

Creates a webhook subscription for the authenticated project. Only one subscription is allowed per project. The signing secret is returned in subscription responses.

post/api/v3.1/webhook_subscriptions

Request body

webhook_urlstring uri required

HTTPS URL to receive webhook events

enabled_eventsstring[] required

Array of event types to subscribe to

version'V1' | 'V2' | 'V3'

Webhook payload version

Response

Webhook subscription created

idstring webhookSubscriptionId required

Unique subscription ID

webhook_urlstring required

Webhook destination URL

version'V1' | 'V2' | 'V3' required

Webhook payload version

enabled_eventsstring[] required

Subscribed event types

secretstring required

Signing secret for HMAC verification

created_atstring required

ISO 8601 timestamp

updated_atstring required

ISO 8601 timestamp

Changes

Changed in 3 of the 61 revisions of this API.5

  • 589a7d115a5e2See the full diff
    • ○

      the endpoint scheme security CookieAuth was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security UserApiKeyAuth was removed from the API

      api-security-removed

  • 55e9c3b27c952See the full diff
    • ○

      api tag Webhook Subscriptions added

      api-tag-added

    • ○

      api tag Webhooks removed

      api-tag-removed

  • 52c71f747c651See the full diff
    • ○

      endpoint added

      endpoint-added