This documentation page includes the list of all events emitted by Medusa's workflows.

Cart Events#

Summary#

Event	Description
cart.created	Emitted when a cart is created.
cart.updated	Emitted when a cart's details are updated.
cart.customer_updated	Emitted when the customer in the cart is updated.
cart.region_updated	Emitted when the cart's region is updated. This event is emitted alongside the CartWorkflowEvents.UPDATED event.

cart.created#

Emitted when a cart is created.

Payload

Code
1{2  id, // The ID of the cart3}

Workflows Emitting this Event

• createCartWorkflow

---

cart.updated#

Emitted when a cart's details are updated.

Payload

Code
1{2  id, // The ID of the cart3}

Workflows Emitting this Event

• updateLineItemInCartWorkflow
• updateCartWorkflow
• addToCartWorkflow
• addShippingMethodToCartWorkflow

---

cart.customer_updated#

Emitted when the customer in the cart is updated.

Payload

Code
1{2  id, // The ID of the cart3}

Workflows Emitting this Event

• updateCartWorkflow

---

cart.region_updated#

Emitted when the cart's region is updated. This event is emitted alongside the CartWorkflowEvents.UPDATED event.

Payload

Code
1{2  id, // The ID of the cart3}

Workflows Emitting this Event

• updateCartWorkflow

---

Customer Events#

Summary#

Event	Description
customer.created	Emitted when a customer is created.
customer.updated	Emitted when a customer is updated.
customer.deleted	Emitted when a customer is deleted.

customer.created#

Emitted when a customer is created.

Payload

Code
1[{2  id, // The ID of the customer3}]

Workflows Emitting this Event

• createCustomersWorkflow
• createCustomerAccountWorkflow

---

customer.updated#

Emitted when a customer is updated.

Payload

Code
1[{2  id, // The ID of the customer3}]

Workflows Emitting this Event

• updateCustomersWorkflow

---

customer.deleted#

Emitted when a customer is deleted.

Payload

Code
1[{2  id, // The ID of the customer3}]

Workflows Emitting this Event

• deleteCustomersWorkflow
• removeCustomerAccountWorkflow

---

Order Events#

Summary#

Event	Description
order.updated	Emitted when the details of an order or draft order is updated. This doesn't include updates made by an edit.
order.placed	Emitted when an order is placed, or when a draft order is converted to an order.
order.canceled	Emitted when an order is canceld.
order.completed	Emitted when orders are completed.
order.archived	Emitted when an order is archived.
order.fulfillment_created	Emitted when a fulfillment is created for an order.
order.fulfillment_canceled	Emitted when an order's fulfillment is canceled.
order.return_requested	Emitted when a return request is confirmed.
order.return_received	Emitted when a return is marked as received.
order.claim_created	Emitted when a claim is created for an order.
order.exchange_created	Emitted when an exchange is created for an order.
order.transfer_requested	Emitted when an order is requested to be transferred to another customer.

order.updated#

Emitted when the details of an order or draft order is updated. This doesn't include updates made by an edit.

Payload

Code
1{2  id, // The ID of the order3}

Workflows Emitting this Event

• updateOrderWorkflow
• updateDraftOrderWorkflow

---

order.placed#

Emitted when an order is placed, or when a draft order is converted to an order.

Payload

Code
1{2  id, // The ID of the order3}

Workflows Emitting this Event

• completeCartWorkflow
• convertDraftOrderWorkflow
• processPaymentWorkflow

---

order.canceled#

Emitted when an order is canceld.

Payload

Code
1{2  id, // The ID of the order3}

Workflows Emitting this Event

• cancelOrderWorkflow

---

order.completed#

Emitted when orders are completed.

Payload

Code
1[{2  id, // The ID of the order3}]

Workflows Emitting this Event

• completeOrderWorkflow

---

order.archived#

Emitted when an order is archived.

Payload

Code
1[{2  id, // The ID of the order3}]

Workflows Emitting this Event

• archiveOrderWorkflow

---

order.fulfillment_created#

Emitted when a fulfillment is created for an order.

Payload

Code
1{2  order_id, // The ID of the order3  fulfillment_id, // The ID of the fulfillment4  no_notification, // Whether to notify the customer5}

Workflows Emitting this Event

• createOrderFulfillmentWorkflow

---

order.fulfillment_canceled#

Emitted when an order's fulfillment is canceled.

Payload

Code
1{2  order_id, // The ID of the order3  fulfillment_id, // The ID of the fulfillment4  no_notification, // Whether to notify the customer5}

Workflows Emitting this Event

• cancelOrderFulfillmentWorkflow

---

order.return_requested#

Emitted when a return request is confirmed.

Payload

Code
1{2  order_id, // The ID of the order3  return_id, // The ID of the return4}

Workflows Emitting this Event

• createAndCompleteReturnOrderWorkflow
• confirmReturnRequestWorkflow

---

order.return_received#

Emitted when a return is marked as received.

Payload

Code
1{2  order_id, // The ID of the order3  return_id, // The ID of the return4}

Workflows Emitting this Event

• createAndCompleteReturnOrderWorkflow
• confirmReturnReceiveWorkflow

---

order.claim_created#

Emitted when a claim is created for an order.

Payload

Code
1{2  order_id, // The ID of the order3  claim_id, // The ID of the claim4}

Workflows Emitting this Event

• confirmClaimRequestWorkflow

---

order.exchange_created#

Emitted when an exchange is created for an order.

Payload

Code
1{2  order_id, // The ID of the order3  exchange_id, // The ID of the exchange4}

Workflows Emitting this Event

• confirmExchangeRequestWorkflow

---

order.transfer_requested#

Emitted when an order is requested to be transferred to another customer.

Payload

Code
1{2  id, // The ID of the order3  order_change_id, // The ID of the order change created for the transfer4}

Workflows Emitting this Event

• requestOrderTransferWorkflow

---

Order Edit Events#

Summary#

Event	Description
order-edit.requested	Emitted when an order edit is requested.
order-edit.confirmed	Emitted when an order edit request is confirmed.
order-edit.canceled	Emitted when an order edit request is canceled.

order-edit.requested#

Emitted when an order edit is requested.

Payload

Code
1{2  order_id, // The ID of the order3  actions, // The actions to edit the order4}

Workflows Emitting this Event

• requestOrderEditRequestWorkflow

---

order-edit.confirmed#

Emitted when an order edit request is confirmed.

Payload

Code
1{2  order_id, // The ID of the order3  actions, // The actions to edit the order4}

Workflows Emitting this Event

• confirmOrderEditRequestWorkflow

---

order-edit.canceled#

Emitted when an order edit request is canceled.

Payload

Code
1{2  order_id, // The ID of the order3  actions, // The actions to edit the order4}

Workflows Emitting this Event

• cancelBeginOrderEditWorkflow

---

User Events#

Summary#

Event	Description
user.created	Emitted when users are created.
user.updated	Emitted when users are updated.
user.deleted	Emitted when users are deleted.

user.created#

Emitted when users are created.

Payload

Code
1[{2  id, // The ID of the user3}]

Workflows Emitting this Event

• createUsersWorkflow
• createUserAccountWorkflow
• acceptInviteWorkflow

---

user.updated#

Emitted when users are updated.

Payload

Code
1[{2  id, // The ID of the user3}]

Workflows Emitting this Event

• updateUsersWorkflow

---

user.deleted#

Emitted when users are deleted.

Payload

Code
1[{2  id, // The ID of the user3}]

Workflows Emitting this Event

• deleteUsersWorkflow
• removeUserAccountWorkflow

---

Auth Events#

Summary#

Event	Description
auth.password_reset	Emitted when a reset password token is generated. You can listen to this event to send a reset password email to the user or customer, for example.

auth.password_reset#

Emitted when a reset password token is generated. You can listen to this event to send a reset password email to the user or customer, for example.

Payload

Code
1{2  entity_id, // The identifier of the user or customer. For example, an email address.3  actor_type, // The type of actor. For example, "customer", "user", or custom.4  token, // The generated token.5}

Workflows Emitting this Event

• generateResetPasswordTokenWorkflow

---

Sales Channel Events#

Summary#

Event	Description
sales-channel.created	Emitted when sales channels are created.
sales-channel.updated	Emitted when sales channels are updated.
sales-channel.deleted	Emitted when sales channels are deleted.

sales-channel.created#

Emitted when sales channels are created.

Payload

Code
1[{2  id, // The ID of the sales channel3}]

Workflows Emitting this Event

• createSalesChannelsWorkflow

---

sales-channel.updated#

Emitted when sales channels are updated.

Payload

Code
1[{2  id, // The ID of the sales channel3}]

Workflows Emitting this Event

• updateSalesChannelsWorkflow

---

sales-channel.deleted#

Emitted when sales channels are deleted.

Payload

Code
1[{2  id, // The ID of the sales channel3}]

Workflows Emitting this Event

• deleteSalesChannelsWorkflow

---

Product Category Events#

Summary#

Event	Description
product-category.created	Emitted when product categories are created.
product-category.updated	Emitted when product categories are updated.
product-category.deleted	Emitted when product categories are deleted.

product-category.created#

Emitted when product categories are created.

Payload

Code
1[{2  id, // The ID of the product category3}]

Workflows Emitting this Event

• createProductCategoriesWorkflow

---

product-category.updated#

Emitted when product categories are updated.

Payload

Code
1[{2  id, // The ID of the product category3}]

Workflows Emitting this Event

• updateProductCategoriesWorkflow

---

product-category.deleted#

Emitted when product categories are deleted.

Payload

Code
1[{2  id, // The ID of the product category3}]

Workflows Emitting this Event

• deleteProductCategoriesWorkflow

---

Product Collection Events#

Summary#

Event	Description
product-collection.created	Emitted when product collections are created.
product-collection.updated	Emitted when product collections are updated.
product-collection.deleted	Emitted when product collections are deleted.

product-collection.created#

Emitted when product collections are created.

Payload

Code
1[{2  id, // The ID of the product collection3}]

Workflows Emitting this Event

• createCollectionsWorkflow

---

product-collection.updated#

Emitted when product collections are updated.

Payload

Code
1[{2  id, // The ID of the product collection3}]

Workflows Emitting this Event

• updateCollectionsWorkflow

---

product-collection.deleted#

Emitted when product collections are deleted.

Payload

Code
1[{2  id, // The ID of the product collection3}]

Workflows Emitting this Event

• deleteCollectionsWorkflow

---

Product Variant Events#

Summary#

Event	Description
product-variant.updated	Emitted when product variants are updated.
product-variant.created	Emitted when product variants are created.
product-variant.deleted	Emitted when product variants are deleted.

product-variant.updated#

Emitted when product variants are updated.

Payload

Code
1[{2  id, // The ID of the product variant3}]

Workflows Emitting this Event

• updateProductVariantsWorkflow
• batchProductVariantsWorkflow

---

product-variant.created#

Emitted when product variants are created.

Payload

Code
1[{2  id, // The ID of the product variant3}]

Workflows Emitting this Event

• createProductVariantsWorkflow
• createProductsWorkflow
• batchProductVariantsWorkflow
• batchProductsWorkflow
• importProductsWorkflow

---

product-variant.deleted#

Emitted when product variants are deleted.

Payload

Code
1[{2  id, // The ID of the product variant3}]

Workflows Emitting this Event

• deleteProductVariantsWorkflow
• batchProductVariantsWorkflow

---

Product Events#

Summary#

Event	Description
product.updated	Emitted when products are updated.
product.created	Emitted when products are created.
product.deleted	Emitted when products are deleted.

product.updated#

Emitted when products are updated.

Payload

Code
1[{2  id, // The ID of the product3}]

Workflows Emitting this Event

• updateProductsWorkflow
• batchProductsWorkflow
• importProductsWorkflow

---

product.created#

Emitted when products are created.

Payload

Code
1[{2  id, // The ID of the product3}]

Workflows Emitting this Event

• createProductsWorkflow
• batchProductsWorkflow
• importProductsWorkflow

---

product.deleted#

Emitted when products are deleted.

Payload

Code
1[{2  id, // The ID of the product3}]

Workflows Emitting this Event

• deleteProductsWorkflow
• batchProductsWorkflow
• importProductsWorkflow

---

Product Type Events#

Summary#

Event	Description
product-type.updated	Emitted when product types are updated.
product-type.created	Emitted when product types are created.
product-type.deleted	Emitted when product types are deleted.

product-type.updated#

Emitted when product types are updated.

Payload

Code
1[{2  id, // The ID of the product type3}]

Workflows Emitting this Event

• updateProductTypesWorkflow

---

product-type.created#

Emitted when product types are created.

Payload

Code
1[{2  id, // The ID of the product type3}]

Workflows Emitting this Event

• createProductTypesWorkflow

---

product-type.deleted#

Emitted when product types are deleted.

Payload

Code
1[{2  id, // The ID of the product type3}]

Workflows Emitting this Event

• deleteProductTypesWorkflow

---

Product Tag Events#

Summary#

Event	Description
product-tag.updated	Emitted when product tags are updated.
product-tag.created	Emitted when product tags are created.
product-tag.deleted	Emitted when product tags are deleted.

product-tag.updated#

Emitted when product tags are updated.

Payload

Code
1[{2  id, // The ID of the product tag3}]

Workflows Emitting this Event

• updateProductTagsWorkflow

---

product-tag.created#

Emitted when product tags are created.

Payload

Code
1[{2  id, // The ID of the product tag3}]

Workflows Emitting this Event

• createProductTagsWorkflow

---

product-tag.deleted#

Emitted when product tags are deleted.

Payload

Code
1[{2  id, // The ID of the product tag3}]

Workflows Emitting this Event

• deleteProductTagsWorkflow

---

Product Option Events#

Summary#

Event	Description
product-option.updated	Emitted when product options are updated.
product-option.created	Emitted when product options are created.
product-option.deleted	Emitted when product options are deleted.

product-option.updated#

Emitted when product options are updated.

Payload

Code
1[{2  id, // The ID of the product option3}]

Workflows Emitting this Event

• updateProductOptionsWorkflow

---

product-option.created#

Emitted when product options are created.

Payload

Code
1[{2  id, // The ID of the product option3}]

Workflows Emitting this Event

• createProductOptionsWorkflow

---

product-option.deleted#

Emitted when product options are deleted.

Payload

Code
1[{2  id, // The ID of the product option3}]

Workflows Emitting this Event

• deleteProductOptionsWorkflow

---

Invite Events#

Summary#

Event	Description
invite.accepted	Emitted when an invite is accepted.
invite.created	Emitted when invites are created. You can listen to this event to send an email to the invited users, for example.
invite.deleted	Emitted when invites are deleted.
invite.resent	Emitted when invites should be resent because their token was refreshed. You can listen to this event to send an email to the invited users, for example.

invite.accepted#

Emitted when an invite is accepted.

Payload

Code
1{2  id, // The ID of the invite3}

Workflows Emitting this Event

• acceptInviteWorkflow

---

invite.created#

Emitted when invites are created. You can listen to this event to send an email to the invited users, for example.

Payload

Code
1[{2  id, // The ID of the invite3}]

Workflows Emitting this Event

• createInvitesWorkflow

---

invite.deleted#

Emitted when invites are deleted.

Payload

Code
1[{2  id, // The ID of the invite3}]

Workflows Emitting this Event

• deleteInvitesWorkflow

---

invite.resent#

Emitted when invites should be resent because their token was refreshed. You can listen to this event to send an email to the invited users, for example.

Payload

Code
1[{2  id, // The ID of the invite3}]

Workflows Emitting this Event

• refreshInviteTokensWorkflow

---

Region Events#

Summary#

Event	Description
region.updated	Emitted when regions are updated.
region.created	Emitted when regions are created.
region.deleted	Emitted when regions are deleted.

region.updated#

Emitted when regions are updated.

Payload

Code
1[{2  id, // The ID of the region3}]

Workflows Emitting this Event

• updateRegionsWorkflow

---

region.created#

Emitted when regions are created.

Payload

Code
1[{2  id, // The ID of the region3}]

Workflows Emitting this Event

• createRegionsWorkflow

---

region.deleted#

Emitted when regions are deleted.

Payload

Code
1[{2  id, // The ID of the region3}]

Workflows Emitting this Event

• deleteRegionsWorkflow

---

Fulfillment Events#

Summary#

Event	Description
shipment.created	Emitted when a shipment is created for an order.
delivery.created	Emitted when a fulfillment is marked as delivered.

shipment.created#

Emitted when a shipment is created for an order.

Payload

Code
1{2  id, // the ID of the shipment3  no_notification, // whether to notify the customer4}

Workflows Emitting this Event

• createOrderShipmentWorkflow

---

delivery.created#

Emitted when a fulfillment is marked as delivered.

Payload

Code
1{2  id, // the ID of the fulfillment3}

Workflows Emitting this Event

• markOrderFulfillmentAsDeliveredWorkflow