Webhooks

This section of the API documentation provides details on the webhooks available in our system.

Subscription Management

This page lists helper endpoints that allow you to subscribe to and unsubscribe from webhooks.

Webhook Details

Each webhook is documented separately on individual subpages, providing specific information on their payload structure.

---

Endpoints for Subscription Management

Get Webhook Event Types

get

Authorizations

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/webhooks/types HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "description": "text",
    "event": "text"
  }
]

Get Webhook Subscriptions

get

Authorizations

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/webhooks/ HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "events": [
      "order.created"
    ],
    "url": "https://example.com",
    "id": 1,
    "description": "text",
    "enabled": true,
    "created_at": "2025-06-09T03:56:02.731Z"
  }
]

Post Webhook Subscription

post

Authorizations

Body

urlstring · uri · min: 1 · max: 2083RequiredExample: https://example.com

descriptionany ofOptional

stringOptional

or

nullOptional

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/webhooks/ HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "description": "text"
}

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "id": 1,
  "description": "text",
  "enabled": true,
  "created_at": "2025-06-09T03:56:02.731Z",
  "client_secret": "text"
}

Get Webhook Subscription

get

Authorizations

Path parameters

subscription_idintegerRequired

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/webhooks/{subscription_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "id": 1,
  "description": "text",
  "enabled": true,
  "created_at": "2025-06-09T03:56:02.731Z"
}

Delete Webhook Subscription

delete

Authorizations

Path parameters

subscription_idintegerRequired

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/webhooks/{subscription_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Update Webhook Subscription Patch

patch

Authorizations

Path parameters

subscription_idintegerRequired

Body

eventsany ofOptional

or

nullOptional

urlany ofOptional

string · uri · min: 1 · max: 2083OptionalExample: https://example.com

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

enabledany ofOptional

booleanOptional

or

nullOptional

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/webhooks/{subscription_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "description": "text",
  "enabled": true
}

{
  "events": [
    "order.created"
  ],
  "url": "https://example.com",
  "id": 1,
  "description": "text",
  "enabled": true,
  "created_at": "2025-06-09T03:56:02.731Z"
}