v55

latestOpenAPI 3.1.0CC-BY-NC-SA-4.0raw.githubusercontent.com2026-08-011243791.8 MB

Webhooks API

Test a webhook

Sends a test event to the webhook to verify the endpoint is working as expected.

post/v2/webhooks/{webhookId}/ping

idempotency-keystring

Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

testmodeboolean

You can enable test mode by setting testmode to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Accepted.