Partner Webhooks

Send Test Partner Webhook Event

Sends a test event to a partner webhook subscription and queues it for delivery so you can verify your endpoint and signature handling.

post/partner/webhooks/subscriptions/{subscription_id}/test

Request

Path parameters

subscription_idstring uuid required

The webhook subscription.

Response

Successful Response

event_idstring uuid required

The webhook.test event that was created.

delivery_idstring uuid nullable required

Delivery created for the event, to inspect with Get Delivery. null if no delivery was created, in which case queued is false.

queuedboolean required

Whether the test event was queued for delivery. The test event bypasses the subscription's event-type filter, so it is sent even if the subscription does not select webhook.test.

Changes

No recorded changes to this operation across all 1 revision of this API.