Backend API
These are the event types that are currently recorded in Swell, grouped by model. They use a common naming convention and all models (including custom ones) have the basic events .created, .updated, and .deleted. Some models also trigger events specific to their functionality.
You can see an example of a model payload below by selecting an event type.
- account.deleted
Occurs when an account is deleted.
- account.address.deleted
Occurs when an address is deleted from an account.
- account.created
Occurs when an account is created.
- account.credit.created
Occurs when store credit is added to an account.
- account.updated
Occurs when an account’s information changes.
- account.account-card.deleted
Occurs when a credit card is deleted from an account.
- account.credit.deleted
Occurs when an account’s store credit is deleted.
- account.credit.updated
Occurs when the details of an account’s store credit changes.
- account.account-card.updated
Occurs when an account’s credit card information changes.
- account.account-card.created
Occurs when a credit card is added to an account.
- account.address.updated
Occurs when an account’s address changes.
- account.address.created
Occurs when an address is added to an account.
- cart.created
Occurs when a product is added to a cart.
- cart.converted
Occurs when a cart is converted to an order.
- cart.deleted
Occurs when a cart is deleted.
- cart.abandoned
Occurs when products in a cart are left and not paid for.
- category.updated
Occurs when the properties of a category change.
- category.created
Occurs when a category is created.
- category.products.added
Occurs when a product is added to a category.
- category.products.removed
Occurs when a product is removed from a category.
- category.deleted
Occurs when a category is deleted.
- coupon.deleted
Occurs when a coupon is deleted.
- coupon.code.deleted
Occurs when a coupon code is deleted.
- coupon.updated
Occurs when the details of a coupon change.
- coupon.generation.completed
Occurs when a series of coupon codes are generated.
- coupon.code.created
Occurs when a coupon code is created.
- coupon.created
Occurs when a coupon is created.
- invoice.deleted
Occurs when an invoice is deleted.
- invoice.refund_failed
Occurs when an attempt to refund an invoice fails.
- invoice.refund_succeeded
Occurs when an attempt to refund an invoice succeeds.
- invoice.updated
Occurs when invoice details change.
- invoice.created
Occurs when an invoice is created.
- order.delivered
Occurs when a shipment is marked delivered
- order.deleted
Occurs when an order is deleted.
- order.canceled
Occurs when an order is canceld
- order.updated
Occurs when order details change.
- order.created
Occurs when an order is created.
- order.paid
Occurs when an order is paid.
- order.submitted
Occurs when an order is submitted.
- page.created
Occurs when a page is created.
- page.updated
Occurs when information on a page changes.
- page.deleted
Occurs when a page is deleted.
- payment.voided
Occurs when a payment is voided.
- payment.succeeded
Occurs when a payment attempt succeeds.
- payment.refund.succeeded
Occurs when an attempt to refund payment succeeds.
- payment.refund.failed
Occurs when an attempt to refund payment fails.
- payment.failed
Occurs when a payment attempt fails.
- payment.refund.voided
Occurs when an attempt to refund payment is voided.
- products.variant.updated
Occurs when the properties of a product variant change.
- products.updated
Occurs when the properties of a product change.
- products.created
Occurs when a product is created.
- products.variant.deleted
Occurs when a product variant is deleted.
- products.stock_adjusted
Occurs when product stock details change.
- products.deleted
Occurs when a product is deleted.
- products.variant.created
Occurs when a product variant is created.
- promotion.deleted
Occurs when a promotion is deleted.
- promotion.created
Occurs when a promotion is created.
- promotion.updated
Occurs when a promotion is updated.
- settings.updated
Occurs when the properties of your store setting change.
- shipment.canceled
Occurs when a shipment is canceled.
- shipment.updated
Occurs when the shipment details change.
- shipment.deleted
Occurs when a shipment is deleted
- shipment.created
Occurs when a shipment is created.
- subscription.trial_ended
Occurs when a subscription's trial period ends
- subscription.canceled
Occurs when a subscription is cancelled
- subscription.trial_will_end
Occurs when a subscriptions trial is near ending
- subscription.resumed
Occurs when a subscription plan is resumed.
- subscription.invoiced
Occurs when a subscription plan is invoiced.
- subscription.created
Occurs when a subscription plan is created.
- subscription.paused
Occurs when a subsription is paused
- subscription.paid
Occurs when a subscription plan is paid.
- subscription.activated
Occurs when a subscription is activated
- subscription.updated
Occurs when an account’s subscription plan changes.
- subscription.deleted
Occurs when a subscription is deleted