Skip to main content
POST
Ping webhook

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required

a UUID ensuring the ping operation is only processed once

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the webhook will be pinged under scope of the sub-partner

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.

Path Parameters

id
string<uuid>
required

the ID of the webhook to ping

Body

application/json; charset=utf-8

Parameters required to ping a webhook

customer_id
string<uuid>
required

Customer ID to use for the webhook ping

Response

Successfully pinged webhook

The response is of type boolean.