Skip to main content

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 IDCategoryDescription
order.createdordersTriggered when a new order is created.
order.paidordersTriggered when an order payment is completed.
order.cancelledordersTriggered when an order is cancelled.
order.fulfilledordersTriggered when an order is marked fulfilled.
cart.abandonedcartsTriggered when an active cart becomes abandoned.
customer.createdcustomersTriggered when a customer profile is created.
customer.updatedcustomersTriggered when a customer profile is updated.
product.createdcatalogTriggered when a product is created.
product.updatedcatalogTriggered when a product is updated.
product.deletedcatalogTriggered when a product is deleted.
inventory.low_stockinventoryTriggered when stock drops below threshold.
discount.redeemeddiscountsTriggered when a discount code is redeemed.
payout.processedfinanceTriggered when a payout is processed.
subscription.renewedbillingTriggered when a subscription renews successfully.

Subscription Usage

  1. List events using GET /api/v1/merchant/webhooks/events.
  2. Create webhook using POST /api/v1/merchant/webhooks with events: ["..."].
  3. 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.