Sign in

v25

OpenAPI 3.1.0raw.githubusercontent.com2026-08-014254240.1 KB
Webhook Subscriptions

Send test event

Dispatches a signed ping.test event to this subscription's URL through the same pipeline as real events. Useful for verifying your receiver's reachability and signature verification in any environment without creating a real business event. Test-event failures do not affect the subscription's health counters or trigger failure-notification emails.

post/v1/webhook_subscriptions/{id}/send_test_event

Path parameters

idstring uuid required

Unique identifier of the webhook subscription.

Headers

Idempotency-Keystring

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Response

The newly created webhook event. Poll its delivery via GET /v1/webhook_deliveries?event_id={id} for receiver status.

idstring uuid required

Unique identifier of the event. Matches the envelope id delivered in the webhook payload and is stable across subscription fan-out and retries.

type'event' required

Resource type discriminator.

event_type'payout.created' | 'payout.initiated' | 'payout.paid' | 'payout.failed' | 'return.initiated' | 'return.paid' | 'return.failed' | 'return.returned' | 'deposit.received' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'ping.test' required

Event type.

api_versionstring required

API version the event payload was rendered at. Stable across retries and redeliveries, and mirrored in the webhook envelope api_version field.

created_atstring date-time required

ISO 8601 UTC timestamp when the event was created.

dataobject required

Event payload. Shape matches the resource schema for event_type.