Create Webhook

Create a new webhook for the authenticated organization to receive event notifications

POST /webhooks

Error

A valid request URL is required to generate request examples

201

{
  "active": true,
  "id": "cuidjkhg3e289y74u5t6v",
  "subscription_events": [
    "ORDER_CREATED",
    "ORDER_COMPLETED"
  ],
  "url": "https://example.com/webhook",
  "webhook_secret": "whsec_xxxxx"
}

Headers

Authorization-Signature · string · required

Authorization header format: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'

Body

application/json

url · string · required

Example:

"https://example.com/webhook"

subscription_events · string[]

Example:

["ORDER_CREATED", "ORDER_COMPLETED"]

Response

201

application/json

Webhook created successfully

id · string · required

Example:

"cuidjkhg3e289y74u5t6v"

url · string · required

Example:

"https://example.com/webhook"

active · boolean · required

Example:

true

webhook_secret · string

Example:

"whsec_xxxxx"

subscription_events · string[]

Example:

["ORDER_CREATED", "ORDER_COMPLETED"]