v50

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-06-1841147599.2 KB

Webhooks

Create a webhook

Creates a new webhook endpoint for the authenticated customer.

post/v3/webhooks

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

display_namestring required

endpoint_urlstring

event_typesstring[]

event_filtersobject nullable

retry_countinteger

timeout_secondsinteger

Example request

{
  "display_name": "Order Notifications",
  "endpoint_url": "https://example.com/webhooks/orders",
  "event_types": [
    "message",
    "templates"
  ],
  "event_filters": {
    "message": [
      "delivered",
      "failed"
    ]
  },
  "retry_count": 3,
  "timeout_seconds": 30,
  "sandbox": false
}

Response

Webhook created successfully

successboolean

Indicates whether the request was successful