less than a minute read • Updated an hour ago
Webhook events reference
The resources you can subscribe a webhook to and the events each one triggers.
Each webhook subscribes to one resource type. Once created, the subscribed resource type can’t be changed — to switch resources, delete the webhook and create a new one.
Resource | Triggered when | Events |
|---|---|---|
Transactions | A transaction is completed, modified by the API or admin, has its payment status updated, or is captured/refunded/voided (beta functionality) |
|
Subscriptions | A subscription is created or updated — for example, a change to its next or end date, or its past due amount. If a change is made to a customer with an associated subscription, and the subscription webhook is enabled, two webhooks are sent: one for the customer, one for the subscription. Note: |
|
Customers | A customer is created or updated. A change to a customer with an associated subscription also triggers a subscription webhook, as above |
|
Transaction Logs | A transaction is updated in a way that adds an entry to the transaction log — including a transaction or transaction item being edited, captured, or refunded, or a transaction being added, moved, or removed from a transaction folder |
|
Changelog | A store resource is updated in a way that adds an entry to the store changelog. Useful for monitoring changes to your store configuration. Excludes resources already covered by other webhooks: Cart, Item, ItemTax, ItemOption, Transaction, TransactionCustomField, TransactionDisplayId, TransactionJournalEntry, TransactionLog, TransactionLogDetail, WebhookLogs, WebhookStatus |
|