Webhooks

List Webhooks

get

Retrieve all webhooks for the authenticated organization

Authorizations

Authorization

Header parameters

Authorization-SignaturestringRequired

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

Responses

200

List of webhooks

application/json

401

Unauthorized - Authentication required

application/json

500

Internal Server Error

application/json

get

/webhooks

HTTPcURLJavaScriptPython

GET /v2/webhooks HTTP/1.1
Authorization-Signature: text
Accept: */*

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

Create Webhook

post

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

Authorizations

Authorization

Header parameters

Authorization-SignaturestringRequired

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

Body

application/json

urlstringRequiredExample: https://example.com/webhook

subscription_eventsstring[]OptionalExample: ["ORDER_CREATED","ORDER_COMPLETED"]

Responses

201

Webhook created successfully

application/json

400

Bad Request - Invalid webhook URL

application/json

401

Unauthorized - Authentication required

application/json

422

Unprocessable Entity - Invalid request body format

application/json

500

Internal Server Error

application/json

post

/webhooks

HTTPcURLJavaScriptPython

POST /v2/webhooks HTTP/1.1
Authorization-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "subscription_events": [
    "ORDER_CREATED",
    "ORDER_COMPLETED"
  ],
  "url": "https://example.com/webhook"
}

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

Update Webhook

put

Update an existing webhook for the authenticated organization

Authorizations

Authorization

Path parameters

webhook_idstringRequired

The unique identifier of the webhook

Header parameters

Authorization-SignaturestringRequired

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

Body

application/json

urlstring · nullableOptionalExample: https://example.com/webhook

subscription_eventsstring[]OptionalExample: ["ORDER_CREATED","ORDER_COMPLETED"]

activeboolean · nullableOptionalExample: true

Responses

200

Webhook updated successfully

application/json

400

Bad Request - Invalid webhook URL or missing webhook ID

application/json

401

Unauthorized - Authentication required

application/json

404

Not Found - Webhook not found

application/json

422

Unprocessable Entity - Invalid request body format

application/json

500

Internal Server Error

application/json

put

/webhooks/{webhook_id}

HTTPcURLJavaScriptPython

PUT /v2/webhooks/{webhook_id} HTTP/1.1
Authorization-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 109

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

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

Delete Webhook

delete

Delete an existing webhook for the authenticated organization

Authorizations

Authorization

Path parameters

webhook_idstringRequired

The unique identifier of the webhook

Header parameters

Authorization-SignaturestringRequired

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

Responses

204

Webhook deleted successfully

400

Bad Request - Missing webhook ID

application/json

401

Unauthorized - Authentication required

application/json

404

Not Found - Webhook not found

application/json

500

Internal Server Error

application/json

delete

/webhooks/{webhook_id}

HTTPcURLJavaScriptPython

DELETE /v2/webhooks/{webhook_id} HTTP/1.1
Authorization-Signature: text
Accept: */*

No content