Webhooks

List webhooks

get

Returns all webhooks for the authenticated merchant

Responses

200

OK

application/json

default

Error

application/problem+json

get

/api/webhooks

HTTPcURLJavaScriptPython

GET /api/webhooks HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "items": [
    {
      "createdAt": "2026-01-29T13:06:09.748Z",
      "enabled": true,
      "eventType": "CARD_PAYMENT",
      "headers": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "id": "whk_01234567-0000-0000-0000-000000000000",
      "modifiedAt": "2026-01-29T13:06:09.748Z",
      "url": "text"
    }
  ]
}

Create webhook

post

Creates a new webhook for the authenticated merchant - only one webhook per event type is allowed per merchant

Body

application/json

Webhook creation data

enabledbooleanRequired

Whether webhook is enabled

eventTypestring · enumRequired

Event type

Possible values:

urlstring · uri · min: 1 · max: 2048Required

Webhook URL (must be HTTPS)

Responses

201

Created

application/json

default

Error

application/problem+json

post

/api/webhooks

HTTPcURLJavaScriptPython

POST /api/webhooks HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "enabled": true,
  "eventType": "CARD_PAYMENT",
  "headers": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "url": "https://example.com"
}

{
  "createdAt": "2026-01-29T13:06:09.748Z",
  "enabled": true,
  "eventType": "CARD_PAYMENT",
  "headers": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "id": "whk_01234567-0000-0000-0000-000000000000",
  "modifiedAt": "2026-01-29T13:06:09.748Z",
  "url": "text"
}

Get webhook

get

Returns a specific webhook by ID for the authenticated merchant

Path parameters

webhookIdstringRequired

Webhook ID

Example: whk_01234567-0000-0000-0000-000000000000

Responses

200

OK

application/json

default

Error

application/problem+json

get

/api/webhooks/{webhookId}

HTTPcURLJavaScriptPython

GET /api/webhooks/{webhookId} HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "createdAt": "2026-01-29T13:06:09.748Z",
  "enabled": true,
  "eventType": "CARD_PAYMENT",
  "headers": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "id": "whk_01234567-0000-0000-0000-000000000000",
  "modifiedAt": "2026-01-29T13:06:09.748Z",
  "url": "text"
}

Delete webhook

delete

Deletes a webhook for the authenticated merchant

Path parameters

webhookIdstringRequired

Webhook ID

Example: whk_01234567-0000-0000-0000-000000000000

Responses

204

No Content

default

Error

application/problem+json

delete

/api/webhooks/{webhookId}

HTTPcURLJavaScriptPython

DELETE /api/webhooks/{webhookId} HTTP/1.1
Host: localhost:8080
Accept: */*

No content

Update webhook

patch

Partially updates a webhook for the authenticated merchant - only provided fields will be updated

Path parameters

webhookIdstringRequired

Webhook ID

Example: whk_01234567-0000-0000-0000-000000000000

Body

application/json

Webhook update data

enabledbooleanOptional

Whether webhook is enabled

urlstring · uri · min: 1 · max: 2048Optional

Webhook URL

Responses

200

OK

application/json

default

Error

application/problem+json

patch

/api/webhooks/{webhookId}

HTTPcURLJavaScriptPython

PATCH /api/webhooks/{webhookId} HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "enabled": true,
  "headers": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "url": "https://example.com"
}

{
  "createdAt": "2026-01-29T13:06:09.748Z",
  "enabled": true,
  "eventType": "CARD_PAYMENT",
  "headers": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "id": "whk_01234567-0000-0000-0000-000000000000",
  "modifiedAt": "2026-01-29T13:06:09.748Z",
  "url": "text"
}