Appearance
Send a test ping
POST
/programs/{id}/webhooks/{webhookId}/test
Posts a test.ping payload signed exactly like a real delivery, bypassing subscription matching. A genuine test of your verification code. The ping is ENQUEUED, not sent inline: the response is the id of the delivery row, and its outcome shows up in the delivery log.
Authorizations
ApiKeyBearer
A shop-scoped API key created in the dashboard and shown exactly once. An MCP tmk_ key presented here returns a 401 that names the mistake.
Type
HTTP (bearer)
Parameters
Header Parameters
Idempotency-Key
Makes a retry safe: a repeat with the same key and body replays the stored response; the same key with a different body is a 409. Keys are remembered for 24h (IDEMPOTENCY_DEDUPE_WINDOW_HOURS). A request without the header is processed normally.
Type
string
Max Length
255Path Parameters
id*
An opaque id. The API never promises an id format.
Type
Requiredstring
webhookId*
An opaque id. The API never promises an id format.
Type
Requiredstring
Responses
Send a test ping
application/json
JSON "delivery_id": "whd_docsfixture0001"
{
}
POST
/programs/{id}/webhooks/{webhookId}/test