Observable Events
You can pass multiple observable keys to the observes field of the integration object, or you can create individual events. You can use an array when you handle multiple webhooks at the same URL.
| Entity/Resource | Action | Observable Key | Availability Level - Store/Organization |
|---|---|---|---|
| Address | Created | address.created | Store |
| Updated | address.updated | Store | |
| Deleted | address.deleted | Store | |
| Account | Created | account.created | Store |
| Updated | account.updated | Store | |
| Deleted | account.deleted | Store | |
| Account Member | Created | account-member.created | Store |
| Updated | account-member.updated | Store | |
| Deleted | account-member.deleted | Store | |
| Account Membership | Created | account-membership.created | Store |
| Updated | account-membership.updated | Store | |
| Deleted | account-membership.deleted | Store | |
| Carts | Updated | cart.updated | Store |
| Deleted | cart.deleted | Store | |
| Currency | Created | currency.created | Store |
| Updated | currency.updated | Store | |
| Deleted | currency.deleted | Store | |
| Customer | Created | customer.created | Store |
| Updated | customer.updated | Store | |
| Deleted | customer.deleted | Store | |
| File | Created | file.created | Store |
| Deleted | file.deleted | Store | |
| Integration (events) | Created | integration.created | Store, Organization |
| Updated | integration.updated | Store, Organization | |
| Deleted | integration.deleted | Store, Organization | |
| One-Time Password Token Request | Created | one-time-password-token-request.created | Store |
| Order Events | |||
/checkout | Created | order.created | Store |
/orders/:id/payments | Updated | order.updated/order.paid. The event order.paid is triggered when the payment status is paid. The event order.updated is triggered when the order is captured, completed, refunded, anonymized, or updated. | Store |
/orders/:id | Fulfilled/Canceled | order.fulfilled/order.cancelled | Store |
/orders/:id/payments | Authorized | order.authorized | Store |
/orders/:id/transactions/:id/capture | Paid/Captured | order.paid/ order.updated. The event order.paid is triggered when the order status is completed and captured, and the payment status is paid. The event order.updated is triggered when the order is captured, completed, refunded, anonymized, or updated. | Store |
/orders/:id/transactions/:id/refund | Refunded | order.refunded | Store |
| Payment Gateway | Updated | payment-gateway.updated | Store |
| Catalog | |||
| Catalog releases | Created | catalog-release.created | Store, Organization |
| Updated | catalog-release.updated | Store, Organization | |
| Deleted | catalog-release.deleted | Store, Organization | |
| Catalog rules | Created | catalog-rule.created | Store |
| Updated | catalog-rule.updated | Store | |
| Deleted | catalog-rule.deleted | Store | |
| Settings | Created | settings.created | Store |
| Updated | settings.updated | Store | |
| Stock Transaction | Created | stock-transaction.created | Store |
| Transaction | Created | transaction.created | Store |
| Updated | transaction.updated | Store | |
| User Authentication Info | Created | user-authentication-info.created | Store |
| Updated | user-authentication-info.updated | Store | |
| Deleted | user-authentication-info.deleted | Store |
Store-level events contain store_id and org_id whereas, organization-level events contain only org_id.