Sign in

v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB
Webhooks

Send a test webhook event for a subscription

Send a test webhook event for a subscription

Required scope: application/webhooks:write

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

Path parameters

subscription_idstring required

The unique identifier of the subscription.

The unique identifier of the subscription.

Request body

event_type'item_category.created' | 'item_category.deleted' | 'item_category.updated' | 'item.created' | 'item.deleted' | 'item.updated' | 'order.cancelled' | 'order.completed' | 'order.created' | 'order.updated' | 'payment.created' | 'payment.refunded' required

Example request

{
  "event_type": "payment.created"
}

Response

Successful Response

message_idstring required

The unique message identifier of the webhook event.

Example response

{
  "message_id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}