Events Catalog
Audience: Developer
Webhook event definitions are served by:
GET /api/v1/merchant/webhooks/events
Each event has id, name, category, and description.
Supported Events
| Event ID | Category | Description |
|---|---|---|
order.created | orders | Triggered when a new order is created. |
order.paid | orders | Triggered when an order payment is completed. |
order.cancelled | orders | Triggered when an order is cancelled. |
order.fulfilled | orders | Triggered when an order is marked fulfilled. |
cart.abandoned | carts | Triggered when an active cart becomes abandoned. |
customer.created | customers | Triggered when a customer profile is created. |
customer.updated | customers | Triggered when a customer profile is updated. |
product.created | catalog | Triggered when a product is created. |
product.updated | catalog | Triggered when a product is updated. |
product.deleted | catalog | Triggered when a product is deleted. |
inventory.low_stock | inventory | Triggered when stock drops below threshold. |
discount.redeemed | discounts | Triggered when a discount code is redeemed. |
payout.processed | finance | Triggered when a payout is processed. |
subscription.renewed | billing | Triggered when a subscription renews successfully. |
Subscription Usage
- List events using
GET /api/v1/merchant/webhooks/events. - Create webhook using
POST /api/v1/merchant/webhookswithevents: ["..."]. - Rotate endpoint secret when needed with
POST /api/v1/merchant/webhooks/{webhookID}/rotate-secret.
Notes
- Event IDs are stable identifiers.
- New event types are additive.
- Consumers should ignore unknown fields for forward compatibility.