v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Webhooks

Create webhook endpoint

Create a new webhook endpoint.

post/v1/webhooks/endpoints

Request body

descriptionstring

Webhook endpoint description.

urlstring uri required

Webhook endpoint URL.

secretstring

Webhook endpoint verification secret (base64 encoded random bytes). If not defined, a secret is automatically generated and only accessible in the UI.

rate_limitnumber

Webhook rate limit (per second).

event_typesstring[]

Webhook event types filter. If not defined, all event messages will be sent.

Example request

{
  "description": "Production webhook endpoint",
  "url": "https://example.com/webhook",
  "event_types": [
    "customer.created",
    "customer.updated"
  ]
}

Response

idstring required

Webhook endpoint ID.

descriptionstring required

Webhook endpoint description.

urlstring uri required

Webhook endpoint URL.

rate_limitnumber nullable required

Webhook rate limit (per second).

event_typesstring[] nullable required

Webhook event types filter. If not defined, all event messages will be sent.

created_atstring date-time required

Webhook creation date.

Example response

{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "description": "Production webhook endpoint",
  "url": "https://example.com/webhook",
  "event_types": [
    "customer.created",
    "customer.updated"
  ],
  "created_at": "2024-01-20T16:04:11Z"
}