Skip to main content

Create webhook subscription

POST 
/v1/subscriptions

Create a new webhook subscription to receive events at a specified endpoint URL.

Use Case: Set up a webhook endpoint to receive real-time notifications when specific events occur in your system.

Subscription Types:

  • Event-specific: Subscribe to specific event types by providing eventTypeIds
  • All events: Subscribe to all events by setting subscribedToAll to true

Webhook Delivery:

  • Events are delivered via HTTP POST to your endpoint URL
  • Each delivery includes a signature in the X-Webhook-Signature header for verification
  • Failed deliveries are automatically retried based on your retry configuration

Best Practices:

  • Use HTTPS endpoints for security
  • Implement signature verification to ensure authenticity
  • Return 2xx status codes quickly to acknowledge receipt
  • Process webhooks asynchronously to avoid timeouts

Request​

Responses​

Subscription created successfully