v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Subscribe webhook

Scope required: write_webhooks

Rate limit - 5/s

post/2023-10/webhook

Request body

topic'subscription/created' | 'subscription/paused' | 'subscription/cancelled' | 'subscription/resumed' | 'subscription/reactivated' | 'subscription/expired' | 'subscription/delayed' | 'subscription/rescheduled' | 'subscription/updated' | 'subscription/shippingAddressUpdated' | 'order/upcoming' | 'order/processed' | 'order/partiallyProcessed' | 'order/outOfStock' | 'order/skipped' | 'order/unskipped' | 'order/paymentFailed' | 'paymentMethod/updateRequested' | 'paymentMethod/updated' | 'paymentMethod/expiringSoon' | 'flow/completed' | 'giftSubscription/created' | 'subscription/markedForCancellation' | 'analytics_report/export_completed' | 'analytics_report/export_failed' required

Event topic

addressstring required

Address to which the payload should be sent

Response

200

successboolean

messagestring

codestring

Example response

{
  "success": true,
  "message": "Webhook subscribed successfully",
  "data": {
    "id": 18
  },
  "code": "SUCCESS"
}