Events Reference

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

Auth Events#

Event NameDescriptionPayload

auth.password_reset

Emitted when a password of a user, customer, or other actor types is reset.

{
  entity_id, // The user's identifier, such as their email
  token, // The reset token
  actor_type // `user`, `customer`, or custom type
}

Cart Events#

Event NameDescriptionPayload

cart.created

Emitted when a cart is created.

{
  id, // The ID of the cart
}

cart.updated

Emitted when a cart is updated. This includes updates to its items, shipping methods, or information.

{
  id, // The ID of the customer
}

cart.region_updated

Emitted when the region of a cart is updated.

{
  id, // The ID of the customer
}

Customer Events#

Event NameDescriptionPayload

customer.created

Emitted when customers are created.

[{
  id, // The ID of the customer
}]

customer.updated

Emitted when customers are updated.

[{
  id, // The ID of the customer
}]

customer.deleted

Emitted when customers are deleted.

[{
  id, // The ID of the customer
}]

Invite Events#

Event NameDescriptionPayload

invite.accepted

Emitted when an invite is accepted.

{
  id, // The ID of the invite
}

invite.created

Emitted when invites are created.

[{
  id, // The ID of the invite
}]

invite.deleted

Emitted when invites are deleted.

[{
  id, // The ID of the invite
}]

invite.resent

Emitted when invites are resent.

[{
  id, // The ID of the invite
}]

Order Events#

Event NameDescriptionPayload

order.placed

Emitted when the customer completes a cart and an order is placed.

{
  id, // The ID of the order
}

order.canceled

Emitted when an order is canceled.

{
  id, // The ID of the order
}

order.completed

Emitted when orders are completed.

[{
  id, // The ID of the order
}]

order.archived

Emitted when orders are archived.

[{
  id, // The ID of the order
}]

order.fulfillment_created

Emitted when a fulfillment is created for an order.

{
  order_id, // The ID of the order
  fulfillment_id, // The ID of the fulfillment
}

order.fulfillment_canceled

Emitted when a fulfillment is canceled for an order.

{
  order_id, // The ID of the order
  fulfillment_id, // The ID of the fulfillment
}

order.return_requested

Emitted when a return is requested.

{
  order_id, // The ID of the order
  return_id, // The ID of the return
}

order.return_received

Emitted when a return is received.

{
  order_id, // The ID of the order
  return_id, // The ID of the return
}

order.claim_created

Emitted when a claim is created.

{
  order_id, // The ID of the order
  claim_id, // The ID of the claim
}

order.exchange_created

Emitted when an exchange is created.

{
  order_id, // The ID of the order
  exchange_id, // The ID of the exchange
}

order.transfer_requested

Emitted when an order transfer is requested. This is available from Medusa v2.0.5+.

{
  order_id, // The ID of the order
  exchange_id, // The ID of the exchange
}

Product Events#

Event NameDescriptionPayload

product.created

Emitted when products are created.

[{
  id, // The ID of the product
}]

product.updated

Emitted when products are updated.

[{
  id, // The ID of the product
}]

product.deleted

Emitted when products are deleted.

[{
  id, // The ID of the product
}]

Product Category Events#

Event NameDescriptionPayload

product-category.created

Emitted when product categories are created.

[{
  id, // The ID of the category
}]

product-category.updated

Emitted when product categories are updated.

[{
  id, // The ID of the category
}]

product-category.deleted

Emitted when product categories are deleted.

[{
  id, // The ID of the category
}]

Product Collection Events#

Event NameDescriptionPayload

product-collection.created

Emitted when product collections are created.

[{
  id, // The ID of the collection
}]

product-collection.updated

Emitted when product collections are updated.

[{
  id, // The ID of the collection
}]

product-collection.deleted

Emitted when product collections are deleted.

[{
  id, // The ID of the collection
}]

Product Option Events#

Event NameDescriptionPayload

product-option.created

Emitted when product options are created.

[{
  id, // The ID of the option
}]

product-option.updated

Emitted when product options are updated.

[{
  id, // The ID of the option
}]

product-option.deleted

Emitted when product options are deleted.

[{
  id, // The ID of the option
}]

Product Tag Events#

Event NameDescriptionPayload

product-tag.created

Emitted when product tags are created.

[{
  id, // The ID of the tag
}]

product-tag.updated

Emitted when product tags are updated.

[{
  id, // The ID of the tag
}]

product-tag.deleted

Emitted when product tags are deleted.

[{
  id, // The ID of the tag
}]

Product Type Events#

Event NameDescriptionPayload

product-type.created

Emitted when product types are created.

[{
  id, // The ID of the type
}]

product-type.updated

Emitted when product types are updated.

[{
  id, // The ID of the type
}]

product-type.deleted

Emitted when product types are deleted.

[{
  id, // The ID of the type
}]

Product Variant Events#

Event NameDescriptionPayload

product-variant.created

Emitted when product variants are created.

[{
  id, // The ID of the variant
}]

product-variant.updated

Emitted when product variants are updated.

[{
  id, // The ID of the variant
}]

product-variant.deleted

Emitted when product variants are deleted.

[{
  id, // The ID of the variant
}]

Region Events#

Event NameDescriptionPayload

region.created

Emitted when regions are created.

[{
  id, // The ID of the region
}]

region.updated

Emitted when regions are updated.

[{
  id, // The ID of the region
}]

region.deleted

Emitted when regions are deleted.

[{
  id, // The ID of the region
}]

Sales Channel Events#

Event NameDescriptionPayload

sales-channel.created

Emitted when sales channels are created.

[{
  id, // The ID of the sales channel
}]

sales-channel.updated

Emitted when sales channels are updated.

[{
  id, // The ID of the sales channel
}]

sales-channel.deleted

Emitted when sales channels are deleted.

[{
  id, // The ID of the sales channel
}]

User Events#

Event NameDescriptionPayload

user.created

Emitted when users are created.

[{
  id, // The ID of the user
}]

user.updated

Emitted when users are updated.

[{
  id, // The ID of the user
}]

user.deleted

Emitted when users are deleted.

[{
  id, // The ID of the user
}]
Was this page helpful?
Edit this page