| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`batch.created` + + | ++Triggered when a batch job is created. + | ++Object of the following format: + +```js +{ + id //string ID of batch job +} +``` + + | +
| + +`batch.updated` + + | ++Triggered when a batch job is updated. + | ++Object of the following format: + +```js +{ + id //string ID of batch job +} +``` + + | +
| + +`batch.canceled` + + | ++Triggered when a batch job is canceled. + | ++Object of the following format: + +```js +{ + id //string ID of batch job +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`cart.customer_updated` + + | ++Triggered when a cart is associated with a different email than it was already associated with, or if a customer logs in after adding items to their cart as a guest. + | ++The cart ID passed as a string parameter. + | +
| + +`cart.created` + + | ++Triggered when a cart is created. + | ++Object of the following format: + +```js +{ + id //string ID of cart +} +``` + + | +
| + +`cart.updated` + + | ++ +Triggered when a cart and data associated with it (payment sessions, shipping methods, user details, etc…) are updated. + + | ++ +The entire cart as an object. You can refer to the [Cart model](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/cart.ts) for an idea of what fields to expect. + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`claim.created` + + | ++ +Triggered when a claim is created. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of claim + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`claim.updated` + + | ++ +Triggered when a claim is updated. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of claim + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`claim.canceled` + + | ++ +Triggered when a claim is canceled. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of claim + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`claim.fulfillment_created` + + | ++ +Triggered when fulfillment is created for a claim. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of claim + fulfillment_id, //string ID of the fulfillment created + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`claim.shipment_created` + + | ++ +Triggered when a claim fulfillment is set as “shipped”. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of claim + fulfillment_id, //string ID of the fulfillment created + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`claim.refund_processed` + + | ++ +Triggered when a claim of type “refunded” has been refunded. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of claim + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`claim_item.created` + + | ++ +Triggered when claim items are created and associated with a claim. This happens during the creation of claims. + + | ++ +Object of the following format: + +```js +{ + id //string ID of claim item +} +``` + + | +
| + +`claim_item.updated` + + | ++ +Triggered when a claim item is updated. This happens when a claim is updated. + + | ++ +Object of the following format: + +```js +{ + id //string ID of claim item +} +``` + + | +
| + +`claim_item.canceled` + + | ++ +Triggered when a claim is canceled. + + | ++ +Object of the following format: + +```js +{ + id //string ID of claim item +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`customer.created` + + | ++ +Triggered when a customer is created. + + | ++ +The entire customer passed as an object. You can refer to the [Customer model](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/customer.ts) for an idea of what fields to expect. + + | +
| + +`customer.updated` + + | ++ +Triggered when a customer is updated including their information or password, or when a customer account is created that is associated with an existing email (for example, if a customer placed an order with their email as a guest, then created an account with that email). + + | ++ +The entire customer passed as an object. You can refer to the [Customer model](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/customer.ts) for an idea of what fields to expect. + + | +
| + +`customer.password_reset` + + | ++ +Triggered when a customer requests to reset their password. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of customer + email, //string email of the customer + first_name, //string first name of the customer + last_name, //string last name of the customer + token //string reset password token +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`draft_order.created` + + | ++ +Triggered when a draft order is created. + + | ++ +Object of the following format: + +```js +{ + id //string ID of draft order +} +``` + + | +
| + +`draft_order.updated` + + | ++ +Triggered when a draft order and data associated with it (email, billing address, discount, etc…) are updated. + + | ++ +Object of the following format: + +```js +{ + id //string ID of draft order +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`gift_card.created` + + | + ++ +Triggered when a gift card is created. + + | + ++ +Object of the following format: + +``` +{ + id //string ID of gift card +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`invite.created` + + | ++ +Triggered when an invite is created for a user to join the admin team. + + | ++ +Object of the following format: + +```js +{ + id //string ID of invite + token, //string token generated to validate the invited user + user_email //string email of invited user +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`note.created` + + | ++ +Triggered when a note is created. + + | ++ +Object of the following format: + +```js +{ + id //string ID of note +} +``` + + | +
| + +`note.updated` + + | ++ +Triggered when a note is updated. + + | ++ +Object of the following format: + +```js +{ + id //string ID of note +} +``` + + | +
| + +`note.deleted` + + | ++ +Triggered when a note is deleted. + + | ++ +Object of the following format: + +```js +{ + id //string ID of note +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
|
+
+`oauth.token_generated. |
++ +Triggered when a token is generated for an application. + + | ++ +The returned data from the method `generateToken` in the auth handler service of the application. + + | +
|
+
+`oauth.token_refreshed. |
++ +Triggered when the token of an application is refreshed. + + | ++ +The returned data from the method `refreshToken` in the auth handler service of the application. + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`order.placed` + + | ++ +Triggered when a new order is placed. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.updated` + + | ++ +Triggered when an order and data associated with it (shipping method, shipping address, etc…) are updated. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.canceled` + + | ++ +Triggered when an order is canceled. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.completed` + + | ++ +Triggered when an order is completed. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.gift_card_created` + + | ++ +Triggered when a gift card in an order is created. + + | ++ +Object of the following format: + +```js +{ + id //string ID of order +} +``` + + | +
| + +`order.payment_captured` + + | ++ +Triggered when the payment of an order is captured. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.payment_capture_failed` + + | ++ +Triggered when capturing the payment of an order fails. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + payment_id, //string ID of Payment + error, //string error message + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.fulfillment_created` + + | ++ +Triggered when fulfillment is created for an order. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + fulfillment_id, //string ID of fulfillment + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.shipment_created` + + | ++ +Triggered when a shipment is created for fulfillment and the fulfillment is registered as “shipped”. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + fulfillment_id, //string ID of fulfillment + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.fulfillment_canceled` + + | ++ +Triggered when fulfillment of an order is canceled. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + fulfillment_id, //string ID of fulfillment + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.return_requested` + + | ++ +Triggered when a return of an order is requested. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + return_id, //string ID of return + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.items_returned` + + | ++ +Triggered when the items of an order have been returned and the order has been registered as “returned”. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + return_id, //string ID of return + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.return_action_required` + + | ++ +Triggered when the order is being registered as “returned” but there are additional actions required related to refunding the payment. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + return_id, //string ID of return + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.refund_created` + + | ++ +Triggered when the order’s payment is refunded. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order + refund_id, //string ID of refund + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`order.refund_failed` + + | ++ +Triggered when the refund of the order’s payment fails. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order +} +``` + + | +
| + +`order.swap_created` + + | ++ +Triggered when a swap for an order is created. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of order +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`product.created` + + | ++ +Triggered when a product is created. + + | ++ +Object of the following format: + +```js +{ + id //string ID of product +} +``` + + | +
| + +`product.updated` + + | ++ +Triggered when a product and data associated with it (options, variant orders, etc…) is updated. + + | ++ +The entire product passed as an object. You can refer to the [Product model](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/product.ts) for an idea of what fields to expect. + + | +
| + +`product.deleted` + + | ++ +Triggered when a product is deleted. + + | ++ +Object of the following format: + +```js +{ + id //string ID of product +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`product-variant.created` + + | ++ +Triggered when a product variant is created. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of variant + product_id //string ID of product +} +``` + + | +
| + +`product-variant.updated` + + | ++ +Triggered when a product variant is updated. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of variant + product_id, //string ID of product + fields //array of names of updated fields +} +``` + + | +
| + +`product-variant.deleted` + + | ++ +Triggered when a product variant is deleted. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of variant + product_id, //string ID of product + metadata //object of additional data +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`region.created` + + | ++ +Triggered when a region is created. + + | ++ +Object of the following format: + +```js +{ + id //string ID of region +} +``` + + | +
| + +`region.updated` + + | ++ +Triggered when a region or data associated with it (countries, fulfillment providers, etc…) are updated. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of region + fields //array of names of updated fields +} +``` + + | +
| + +`region.deleted` + + | ++ +Triggered when a region is deleted. + + | ++ +Object of the following format: + +```js +{ + id //string ID of region +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`swap.created` + + | ++ +Triggered when a swap is created. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.received` + + | ++ +Triggered when a swap is registered as received. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + order_id, //string ID of order + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.fulfillment_created` + + | ++ +Triggered when fulfillment is created for a swap. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + fulfillment_id, //string ID of fulfillment + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.shipment_created` + + | ++ +Triggered when a shipment is created for a swap and the fulfillment associated with it is set as “shipped”. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + fulfillment_id, //string ID of fulfillment + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.payment_completed` + + | ++ +Triggered when payment is completed for a swap which happens when the cart associated with the swap is registered as completed. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.payment_captured` + + | ++ +Triggered when the payment is captured for a swap. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.payment_capture_failed` + + | ++ +Triggered when the capturing of the payment of a swap fails. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.refund_processed` + + | ++ +Triggered when a swap’s amount difference is processed and refunded. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| + +`swap.process_refund_failed` + + | ++ +Triggered when processing and refunding a swap’s amount difference fails. + + | ++ +Object of the following format: + +```js +{ + id, //string ID of swap + no_notification //boolean indicating whether a notification should be sent or not +} +``` + + | +
| +Event Name + | ++Description + | ++Event Data Payload + | +
|---|---|---|
| + +`user.password_reset` + + | ++ +Triggered when a user requests to reset their password. + + | ++ +Object of the following format: + +```js +{ + email, //string email of user requesting to reset their password + token //token create to reset the password +} +``` + + | +