Files
medusa-store/www/apps/resources/references/modules/events/page.mdx
2025-08-29 12:51:43 +03:00

2521 lines
73 KiB
Plaintext

---
slug: /references/events
sidebar_label: Events Reference
generate_toc: true
---
import { TypeList } from "docs-ui"
# Events Reference
This documentation page includes the list of all events emitted by [Medusa's workflows](https://docs.medusajs.com/resources/medusa-workflows-reference).
## Auth Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[auth.password_reset](#authpassword_reset)
</Table.Cell>
<Table.Cell>
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.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "authpassword_reset", children: (<>auth.password_reset</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="auth.password_reset" payload={`\`\`\`ts
{
entity_id, // The identifier of the user or customer. For example, an email address.
actor_type, // The type of actor. For example, "customer", "user", or custom.
token, // The generated token.
}
\`\`\``} />
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
```ts
{
entity_id, // The identifier of the user or customer. For example, an email address.
actor_type, // The type of actor. For example, "customer", "user", or custom.
token, // The generated token.
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [generateResetPasswordTokenWorkflow](/references/medusa-workflows/generateResetPasswordTokenWorkflow)
---
## Cart Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[cart.created](#cartcreated)
</Table.Cell>
<Table.Cell>
Emitted when a cart is created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[cart.updated](#cartupdated)
</Table.Cell>
<Table.Cell>
Emitted when a cart's details are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[cart.region_updated](#cartregion_updated)
</Table.Cell>
<Table.Cell>
Emitted when the cart's region is updated. This
event is emitted alongside the `cart.updated` event.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[cart.customer_transferred](#cartcustomer_transferred)
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when the customer in the cart is transferred.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "cartcreated", children: (<>cart.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.created" payload={`\`\`\`ts
{
id, // The ID of the cart
}
\`\`\``} />
Emitted when a cart is created.
#### Payload
```ts
{
id, // The ID of the cart
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createCartWorkflow](/references/medusa-workflows/createCartWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "cartupdated", children: (<>cart.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.updated" payload={`\`\`\`ts
{
id, // The ID of the cart
}
\`\`\``} />
Emitted when a cart's details are updated.
#### Payload
```ts
{
id, // The ID of the cart
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateLineItemInCartWorkflow](/references/medusa-workflows/updateLineItemInCartWorkflow)
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
- [addToCartWorkflow](/references/medusa-workflows/addToCartWorkflow)
- [addShippingMethodToCartWorkflow](/references/medusa-workflows/addShippingMethodToCartWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "cartregion_updated", children: (<>cart.region_updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.region_updated" payload={`\`\`\`ts
{
id, // The ID of the cart
}
\`\`\``} />
Emitted when the cart's region is updated. This
event is emitted alongside the `cart.updated` event.
#### Payload
```ts
{
id, // The ID of the cart
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "cartcustomer_transferred", children: (<>cart.customer_transferred
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.customer_transferred" payload={`\`\`\`ts
{
id, // The ID of the cart
customer_id, // The ID of the customer
}
\`\`\``} />
Emitted when the customer in the cart is transferred.
#### Payload
```ts
{
id, // The ID of the cart
customer_id, // The ID of the customer
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [transferCartCustomerWorkflow](/references/medusa-workflows/transferCartCustomerWorkflow)
---
## Customer Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[customer.created](#customercreated)
</Table.Cell>
<Table.Cell>
Emitted when a customer is created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[customer.updated](#customerupdated)
</Table.Cell>
<Table.Cell>
Emitted when a customer is updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[customer.deleted](#customerdeleted)
</Table.Cell>
<Table.Cell>
Emitted when a customer is deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "customercreated", children: (<>customer.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.created" payload={`\`\`\`ts
[{
id, // The ID of the customer
}]
\`\`\``} />
Emitted when a customer is created.
#### Payload
```ts
[{
id, // The ID of the customer
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createCustomersWorkflow](/references/medusa-workflows/createCustomersWorkflow)
- [createCustomerAccountWorkflow](/references/medusa-workflows/createCustomerAccountWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "customerupdated", children: (<>customer.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.updated" payload={`\`\`\`ts
[{
id, // The ID of the customer
}]
\`\`\``} />
Emitted when a customer is updated.
#### Payload
```ts
[{
id, // The ID of the customer
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateCustomersWorkflow](/references/medusa-workflows/updateCustomersWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "customerdeleted", children: (<>customer.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.deleted" payload={`\`\`\`ts
[{
id, // The ID of the customer
}]
\`\`\``} />
Emitted when a customer is deleted.
#### Payload
```ts
[{
id, // The ID of the customer
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteCustomersWorkflow](/references/medusa-workflows/deleteCustomersWorkflow)
- [removeCustomerAccountWorkflow](/references/medusa-workflows/removeCustomerAccountWorkflow)
---
## Fulfillment Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[shipment.created](#shipmentcreated)
</Table.Cell>
<Table.Cell>
Emitted when a shipment is created for an order.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[delivery.created](#deliverycreated)
</Table.Cell>
<Table.Cell>
Emitted when a fulfillment is marked as delivered.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "shipmentcreated", children: (<>shipment.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipment.created" payload={`\`\`\`ts
{
id, // the ID of the fulfillment
no_notification, // (boolean) whether to notify the customer
}
\`\`\``} />
Emitted when a shipment is created for an order.
#### Payload
```ts
{
id, // the ID of the fulfillment
no_notification, // (boolean) whether to notify the customer
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createOrderShipmentWorkflow](/references/medusa-workflows/createOrderShipmentWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "deliverycreated", children: (<>delivery.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="delivery.created" payload={`\`\`\`ts
{
id, // the ID of the fulfillment
}
\`\`\``} />
Emitted when a fulfillment is marked as delivered.
#### Payload
```ts
{
id, // the ID of the fulfillment
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [markOrderFulfillmentAsDeliveredWorkflow](/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow)
---
## Invite Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[invite.accepted](#inviteaccepted)
</Table.Cell>
<Table.Cell>
Emitted when an invite is accepted.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[invite.created](#invitecreated)
</Table.Cell>
<Table.Cell>
Emitted when invites are created. You can listen to this event
to send an email to the invited users, for example.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[invite.deleted](#invitedeleted)
</Table.Cell>
<Table.Cell>
Emitted when invites are deleted.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[invite.resent](#inviteresent)
</Table.Cell>
<Table.Cell>
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.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "inviteaccepted", children: (<>invite.accepted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.accepted" payload={`\`\`\`ts
{
id, // The ID of the invite
}
\`\`\``} />
Emitted when an invite is accepted.
#### Payload
```ts
{
id, // The ID of the invite
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [acceptInviteWorkflow](/references/medusa-workflows/acceptInviteWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "invitecreated", children: (<>invite.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.created" payload={`\`\`\`ts
[{
id, // The ID of the invite
}]
\`\`\``} />
Emitted when invites are created. You can listen to this event
to send an email to the invited users, for example.
#### Payload
```ts
[{
id, // The ID of the invite
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createInvitesWorkflow](/references/medusa-workflows/createInvitesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "invitedeleted", children: (<>invite.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.deleted" payload={`\`\`\`ts
[{
id, // The ID of the invite
}]
\`\`\``} />
Emitted when invites are deleted.
#### Payload
```ts
[{
id, // The ID of the invite
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteInvitesWorkflow](/references/medusa-workflows/deleteInvitesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "inviteresent", children: (<>invite.resent</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.resent" payload={`\`\`\`ts
[{
id, // The ID of the invite
}]
\`\`\``} />
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
```ts
[{
id, // The ID of the invite
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [refreshInviteTokensWorkflow](/references/medusa-workflows/refreshInviteTokensWorkflow)
---
## Order Edit Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[order-edit.requested](#order-editrequested)
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when an order edit is requested.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order-edit.confirmed](#order-editconfirmed)
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when an order edit request is confirmed.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order-edit.canceled](#order-editcanceled)
<Tooltip text="This event was added in version v2.8.0"><Badge variant="blue">v2.8.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when an order edit request is canceled.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "order-editrequested", children: (<>order-edit.requested
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.requested" payload={`\`\`\`ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
\`\`\``} />
Emitted when an order edit is requested.
#### Payload
```ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [requestOrderEditRequestWorkflow](/references/medusa-workflows/requestOrderEditRequestWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "order-editconfirmed", children: (<>order-edit.confirmed
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.confirmed" payload={`\`\`\`ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
\`\`\``} />
Emitted when an order edit request is confirmed.
#### Payload
```ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [confirmOrderEditRequestWorkflow](/references/medusa-workflows/confirmOrderEditRequestWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "order-editcanceled", children: (<>order-edit.canceled
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.canceled" payload={`\`\`\`ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
\`\`\``} />
Emitted when an order edit request is canceled.
#### Payload
```ts
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [cancelBeginOrderEditWorkflow](/references/medusa-workflows/cancelBeginOrderEditWorkflow)
---
## Order Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[order.updated](#orderupdated)
</Table.Cell>
<Table.Cell>
Emitted when the details of an order or draft order is updated. This
doesn't include updates made by an edit.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.placed](#orderplaced)
</Table.Cell>
<Table.Cell>
Emitted when an order is placed, or when a draft order is converted to an
order.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.canceled](#ordercanceled)
</Table.Cell>
<Table.Cell>
Emitted when an order is canceld.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.completed](#ordercompleted)
</Table.Cell>
<Table.Cell>
Emitted when orders are completed.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.archived](#orderarchived)
</Table.Cell>
<Table.Cell>
Emitted when an order is archived.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.fulfillment_created](#orderfulfillment_created)
</Table.Cell>
<Table.Cell>
Emitted when a fulfillment is created for an order.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.fulfillment_canceled](#orderfulfillment_canceled)
</Table.Cell>
<Table.Cell>
Emitted when an order's fulfillment is canceled.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.return_requested](#orderreturn_requested)
</Table.Cell>
<Table.Cell>
Emitted when a return request is confirmed.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.return_received](#orderreturn_received)
</Table.Cell>
<Table.Cell>
Emitted when a return is marked as received.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.claim_created](#orderclaim_created)
</Table.Cell>
<Table.Cell>
Emitted when a claim is created for an order.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.exchange_created](#orderexchange_created)
</Table.Cell>
<Table.Cell>
Emitted when an exchange is created for an order.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[order.transfer_requested](#ordertransfer_requested)
</Table.Cell>
<Table.Cell>
Emitted when an order is requested to be transferred to
another customer.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "orderupdated", children: (<>order.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.updated" payload={`\`\`\`ts
{
id, // The ID of the order
}
\`\`\``} />
Emitted when the details of an order or draft order is updated. This
doesn't include updates made by an edit.
#### Payload
```ts
{
id, // The ID of the order
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateOrderWorkflow](/references/medusa-workflows/updateOrderWorkflow)
- [updateDraftOrderWorkflow](/references/medusa-workflows/updateDraftOrderWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderplaced", children: (<>order.placed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.placed" payload={`\`\`\`ts
{
id, // The ID of the order
}
\`\`\``} />
Emitted when an order is placed, or when a draft order is converted to an
order.
#### Payload
```ts
{
id, // The ID of the order
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [convertDraftOrderWorkflow](/references/medusa-workflows/convertDraftOrderWorkflow)
- [completeCartWorkflow](/references/medusa-workflows/completeCartWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "ordercanceled", children: (<>order.canceled</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.canceled" payload={`\`\`\`ts
{
id, // The ID of the order
}
\`\`\``} />
Emitted when an order is canceld.
#### Payload
```ts
{
id, // The ID of the order
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [cancelOrderWorkflow](/references/medusa-workflows/cancelOrderWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "ordercompleted", children: (<>order.completed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.completed" payload={`\`\`\`ts
[{
id, // The ID of the order
}]
\`\`\``} />
Emitted when orders are completed.
#### Payload
```ts
[{
id, // The ID of the order
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [completeOrderWorkflow](/references/medusa-workflows/completeOrderWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderarchived", children: (<>order.archived</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.archived" payload={`\`\`\`ts
[{
id, // The ID of the order
}]
\`\`\``} />
Emitted when an order is archived.
#### Payload
```ts
[{
id, // The ID of the order
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [archiveOrderWorkflow](/references/medusa-workflows/archiveOrderWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderfulfillment_created", children: (<>order.fulfillment_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.fulfillment_created" payload={`\`\`\`ts
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
\`\`\``} />
Emitted when a fulfillment is created for an order.
#### Payload
```ts
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createOrderFulfillmentWorkflow](/references/medusa-workflows/createOrderFulfillmentWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderfulfillment_canceled", children: (<>order.fulfillment_canceled</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.fulfillment_canceled" payload={`\`\`\`ts
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
\`\`\``} />
Emitted when an order's fulfillment is canceled.
#### Payload
```ts
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [cancelOrderFulfillmentWorkflow](/references/medusa-workflows/cancelOrderFulfillmentWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderreturn_requested", children: (<>order.return_requested</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.return_requested" payload={`\`\`\`ts
{
order_id, // The ID of the order
return_id, // The ID of the return
}
\`\`\``} />
Emitted when a return request is confirmed.
#### Payload
```ts
{
order_id, // The ID of the order
return_id, // The ID of the return
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createAndCompleteReturnOrderWorkflow](/references/medusa-workflows/createAndCompleteReturnOrderWorkflow)
- [confirmReturnRequestWorkflow](/references/medusa-workflows/confirmReturnRequestWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderreturn_received", children: (<>order.return_received</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.return_received" payload={`\`\`\`ts
{
order_id, // The ID of the order
return_id, // The ID of the return
}
\`\`\``} />
Emitted when a return is marked as received.
#### Payload
```ts
{
order_id, // The ID of the order
return_id, // The ID of the return
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createAndCompleteReturnOrderWorkflow](/references/medusa-workflows/createAndCompleteReturnOrderWorkflow)
- [confirmReturnReceiveWorkflow](/references/medusa-workflows/confirmReturnReceiveWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderclaim_created", children: (<>order.claim_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.claim_created" payload={`\`\`\`ts
{
order_id, // The ID of the order
claim_id, // The ID of the claim
}
\`\`\``} />
Emitted when a claim is created for an order.
#### Payload
```ts
{
order_id, // The ID of the order
claim_id, // The ID of the claim
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [confirmClaimRequestWorkflow](/references/medusa-workflows/confirmClaimRequestWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "orderexchange_created", children: (<>order.exchange_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.exchange_created" payload={`\`\`\`ts
{
order_id, // The ID of the order
exchange_id, // The ID of the exchange
}
\`\`\``} />
Emitted when an exchange is created for an order.
#### Payload
```ts
{
order_id, // The ID of the order
exchange_id, // The ID of the exchange
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [confirmExchangeRequestWorkflow](/references/medusa-workflows/confirmExchangeRequestWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "ordertransfer_requested", children: (<>order.transfer_requested</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.transfer_requested" payload={`\`\`\`ts
{
id, // The ID of the order
order_change_id, // The ID of the order change created for the transfer
}
\`\`\``} />
Emitted when an order is requested to be transferred to
another customer.
#### Payload
```ts
{
id, // The ID of the order
order_change_id, // The ID of the order change created for the transfer
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [requestOrderTransferWorkflow](/references/medusa-workflows/requestOrderTransferWorkflow)
---
## Payment Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[payment.captured](#paymentcaptured)
</Table.Cell>
<Table.Cell>
Emitted when a payment is captured.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[payment.refunded](#paymentrefunded)
</Table.Cell>
<Table.Cell>
Emitted when a payment is refunded.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "paymentcaptured", children: (<>payment.captured</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.captured" payload={`\`\`\`ts
{
id, // the ID of the payment
}
\`\`\``} />
Emitted when a payment is captured.
#### Payload
```ts
{
id, // the ID of the payment
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [capturePaymentWorkflow](/references/medusa-workflows/capturePaymentWorkflow)
- [processPaymentWorkflow](/references/medusa-workflows/processPaymentWorkflow)
- [markPaymentCollectionAsPaid](/references/medusa-workflows/markPaymentCollectionAsPaid)
---
<EventHeader headerLvl="3" headerProps={{ id: "paymentrefunded", children: (<>payment.refunded</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.refunded" payload={`\`\`\`ts
{
id, // the ID of the payment
}
\`\`\``} />
Emitted when a payment is refunded.
#### Payload
```ts
{
id, // the ID of the payment
}
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [refundPaymentWorkflow](/references/medusa-workflows/refundPaymentWorkflow)
---
## Product Category Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[product-category.created](#product-categorycreated)
</Table.Cell>
<Table.Cell>
Emitted when product categories are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-category.updated](#product-categoryupdated)
</Table.Cell>
<Table.Cell>
Emitted when product categories are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-category.deleted](#product-categorydeleted)
</Table.Cell>
<Table.Cell>
Emitted when product categories are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-categorycreated", children: (<>product-category.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.created" payload={`\`\`\`ts
[{
id, // The ID of the product category
}]
\`\`\``} />
Emitted when product categories are created.
#### Payload
```ts
[{
id, // The ID of the product category
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createProductCategoriesWorkflow](/references/medusa-workflows/createProductCategoriesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-categoryupdated", children: (<>product-category.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.updated" payload={`\`\`\`ts
[{
id, // The ID of the product category
}]
\`\`\``} />
Emitted when product categories are updated.
#### Payload
```ts
[{
id, // The ID of the product category
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateProductCategoriesWorkflow](/references/medusa-workflows/updateProductCategoriesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-categorydeleted", children: (<>product-category.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.deleted" payload={`\`\`\`ts
[{
id, // The ID of the product category
}]
\`\`\``} />
Emitted when product categories are deleted.
#### Payload
```ts
[{
id, // The ID of the product category
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteProductCategoriesWorkflow](/references/medusa-workflows/deleteProductCategoriesWorkflow)
---
## Product Collection Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[product-collection.created](#product-collectioncreated)
</Table.Cell>
<Table.Cell>
Emitted when product collections are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-collection.updated](#product-collectionupdated)
</Table.Cell>
<Table.Cell>
Emitted when product collections are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-collection.deleted](#product-collectiondeleted)
</Table.Cell>
<Table.Cell>
Emitted when product collections are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-collectioncreated", children: (<>product-collection.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.created" payload={`\`\`\`ts
[{
id, // The ID of the product collection
}]
\`\`\``} />
Emitted when product collections are created.
#### Payload
```ts
[{
id, // The ID of the product collection
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createCollectionsWorkflow](/references/medusa-workflows/createCollectionsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-collectionupdated", children: (<>product-collection.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.updated" payload={`\`\`\`ts
[{
id, // The ID of the product collection
}]
\`\`\``} />
Emitted when product collections are updated.
#### Payload
```ts
[{
id, // The ID of the product collection
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateCollectionsWorkflow](/references/medusa-workflows/updateCollectionsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-collectiondeleted", children: (<>product-collection.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.deleted" payload={`\`\`\`ts
[{
id, // The ID of the product collection
}]
\`\`\``} />
Emitted when product collections are deleted.
#### Payload
```ts
[{
id, // The ID of the product collection
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteCollectionsWorkflow](/references/medusa-workflows/deleteCollectionsWorkflow)
---
## Product Option Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[product-option.updated](#product-optionupdated)
</Table.Cell>
<Table.Cell>
Emitted when product options are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-option.created](#product-optioncreated)
</Table.Cell>
<Table.Cell>
Emitted when product options are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-option.deleted](#product-optiondeleted)
</Table.Cell>
<Table.Cell>
Emitted when product options are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-optionupdated", children: (<>product-option.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.updated" payload={`\`\`\`ts
[{
id, // The ID of the product option
}]
\`\`\``} />
Emitted when product options are updated.
#### Payload
```ts
[{
id, // The ID of the product option
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateProductOptionsWorkflow](/references/medusa-workflows/updateProductOptionsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-optioncreated", children: (<>product-option.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.created" payload={`\`\`\`ts
[{
id, // The ID of the product option
}]
\`\`\``} />
Emitted when product options are created.
#### Payload
```ts
[{
id, // The ID of the product option
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createProductOptionsWorkflow](/references/medusa-workflows/createProductOptionsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-optiondeleted", children: (<>product-option.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.deleted" payload={`\`\`\`ts
[{
id, // The ID of the product option
}]
\`\`\``} />
Emitted when product options are deleted.
#### Payload
```ts
[{
id, // The ID of the product option
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteProductOptionsWorkflow](/references/medusa-workflows/deleteProductOptionsWorkflow)
---
## Product Tag Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[product-tag.updated](#product-tagupdated)
</Table.Cell>
<Table.Cell>
Emitted when product tags are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-tag.created](#product-tagcreated)
</Table.Cell>
<Table.Cell>
Emitted when product tags are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-tag.deleted](#product-tagdeleted)
</Table.Cell>
<Table.Cell>
Emitted when product tags are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-tagupdated", children: (<>product-tag.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.updated" payload={`\`\`\`ts
[{
id, // The ID of the product tag
}]
\`\`\``} />
Emitted when product tags are updated.
#### Payload
```ts
[{
id, // The ID of the product tag
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateProductTagsWorkflow](/references/medusa-workflows/updateProductTagsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-tagcreated", children: (<>product-tag.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.created" payload={`\`\`\`ts
[{
id, // The ID of the product tag
}]
\`\`\``} />
Emitted when product tags are created.
#### Payload
```ts
[{
id, // The ID of the product tag
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createProductTagsWorkflow](/references/medusa-workflows/createProductTagsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-tagdeleted", children: (<>product-tag.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.deleted" payload={`\`\`\`ts
[{
id, // The ID of the product tag
}]
\`\`\``} />
Emitted when product tags are deleted.
#### Payload
```ts
[{
id, // The ID of the product tag
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteProductTagsWorkflow](/references/medusa-workflows/deleteProductTagsWorkflow)
---
## Product Type Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[product-type.updated](#product-typeupdated)
</Table.Cell>
<Table.Cell>
Emitted when product types are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-type.created](#product-typecreated)
</Table.Cell>
<Table.Cell>
Emitted when product types are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-type.deleted](#product-typedeleted)
</Table.Cell>
<Table.Cell>
Emitted when product types are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-typeupdated", children: (<>product-type.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.updated" payload={`\`\`\`ts
[{
id, // The ID of the product type
}]
\`\`\``} />
Emitted when product types are updated.
#### Payload
```ts
[{
id, // The ID of the product type
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateProductTypesWorkflow](/references/medusa-workflows/updateProductTypesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-typecreated", children: (<>product-type.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.created" payload={`\`\`\`ts
[{
id, // The ID of the product type
}]
\`\`\``} />
Emitted when product types are created.
#### Payload
```ts
[{
id, // The ID of the product type
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createProductTypesWorkflow](/references/medusa-workflows/createProductTypesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-typedeleted", children: (<>product-type.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.deleted" payload={`\`\`\`ts
[{
id, // The ID of the product type
}]
\`\`\``} />
Emitted when product types are deleted.
#### Payload
```ts
[{
id, // The ID of the product type
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteProductTypesWorkflow](/references/medusa-workflows/deleteProductTypesWorkflow)
---
## Product Variant Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[product-variant.updated](#product-variantupdated)
</Table.Cell>
<Table.Cell>
Emitted when product variants are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-variant.created](#product-variantcreated)
</Table.Cell>
<Table.Cell>
Emitted when product variants are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product-variant.deleted](#product-variantdeleted)
</Table.Cell>
<Table.Cell>
Emitted when product variants are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "product-variantupdated", children: (<>product-variant.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.updated" payload={`\`\`\`ts
[{
id, // The ID of the product variant
}]
\`\`\``} />
Emitted when product variants are updated.
#### Payload
```ts
[{
id, // The ID of the product variant
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateProductVariantsWorkflow](/references/medusa-workflows/updateProductVariantsWorkflow)
- [batchProductVariantsWorkflow](/references/medusa-workflows/batchProductVariantsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-variantcreated", children: (<>product-variant.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.created" payload={`\`\`\`ts
[{
id, // The ID of the product variant
}]
\`\`\``} />
Emitted when product variants are created.
#### Payload
```ts
[{
id, // The ID of the product variant
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createProductVariantsWorkflow](/references/medusa-workflows/createProductVariantsWorkflow)
- [createProductsWorkflow](/references/medusa-workflows/createProductsWorkflow)
- [batchProductVariantsWorkflow](/references/medusa-workflows/batchProductVariantsWorkflow)
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "product-variantdeleted", children: (<>product-variant.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.deleted" payload={`\`\`\`ts
[{
id, // The ID of the product variant
}]
\`\`\``} />
Emitted when product variants are deleted.
#### Payload
```ts
[{
id, // The ID of the product variant
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteProductVariantsWorkflow](/references/medusa-workflows/deleteProductVariantsWorkflow)
- [batchProductVariantsWorkflow](/references/medusa-workflows/batchProductVariantsWorkflow)
---
## Product Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[product.updated](#productupdated)
</Table.Cell>
<Table.Cell>
Emitted when products are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product.created](#productcreated)
</Table.Cell>
<Table.Cell>
Emitted when products are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[product.deleted](#productdeleted)
</Table.Cell>
<Table.Cell>
Emitted when products are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "productupdated", children: (<>product.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.updated" payload={`\`\`\`ts
[{
id, // The ID of the product
}]
\`\`\``} />
Emitted when products are updated.
#### Payload
```ts
[{
id, // The ID of the product
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateProductsWorkflow](/references/medusa-workflows/updateProductsWorkflow)
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "productcreated", children: (<>product.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.created" payload={`\`\`\`ts
[{
id, // The ID of the product
}]
\`\`\``} />
Emitted when products are created.
#### Payload
```ts
[{
id, // The ID of the product
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createProductsWorkflow](/references/medusa-workflows/createProductsWorkflow)
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "productdeleted", children: (<>product.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.deleted" payload={`\`\`\`ts
[{
id, // The ID of the product
}]
\`\`\``} />
Emitted when products are deleted.
#### Payload
```ts
[{
id, // The ID of the product
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteProductsWorkflow](/references/medusa-workflows/deleteProductsWorkflow)
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
---
## Region Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[region.updated](#regionupdated)
</Table.Cell>
<Table.Cell>
Emitted when regions are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[region.created](#regioncreated)
</Table.Cell>
<Table.Cell>
Emitted when regions are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[region.deleted](#regiondeleted)
</Table.Cell>
<Table.Cell>
Emitted when regions are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "regionupdated", children: (<>region.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.updated" payload={`\`\`\`ts
[{
id, // The ID of the region
}]
\`\`\``} />
Emitted when regions are updated.
#### Payload
```ts
[{
id, // The ID of the region
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateRegionsWorkflow](/references/medusa-workflows/updateRegionsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "regioncreated", children: (<>region.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.created" payload={`\`\`\`ts
[{
id, // The ID of the region
}]
\`\`\``} />
Emitted when regions are created.
#### Payload
```ts
[{
id, // The ID of the region
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createRegionsWorkflow](/references/medusa-workflows/createRegionsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "regiondeleted", children: (<>region.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.deleted" payload={`\`\`\`ts
[{
id, // The ID of the region
}]
\`\`\``} />
Emitted when regions are deleted.
#### Payload
```ts
[{
id, // The ID of the region
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteRegionsWorkflow](/references/medusa-workflows/deleteRegionsWorkflow)
---
## Sales Channel Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[sales-channel.created](#sales-channelcreated)
</Table.Cell>
<Table.Cell>
Emitted when sales channels are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[sales-channel.updated](#sales-channelupdated)
</Table.Cell>
<Table.Cell>
Emitted when sales channels are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[sales-channel.deleted](#sales-channeldeleted)
</Table.Cell>
<Table.Cell>
Emitted when sales channels are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "sales-channelcreated", children: (<>sales-channel.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.created" payload={`\`\`\`ts
[{
id, // The ID of the sales channel
}]
\`\`\``} />
Emitted when sales channels are created.
#### Payload
```ts
[{
id, // The ID of the sales channel
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createSalesChannelsWorkflow](/references/medusa-workflows/createSalesChannelsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "sales-channelupdated", children: (<>sales-channel.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.updated" payload={`\`\`\`ts
[{
id, // The ID of the sales channel
}]
\`\`\``} />
Emitted when sales channels are updated.
#### Payload
```ts
[{
id, // The ID of the sales channel
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateSalesChannelsWorkflow](/references/medusa-workflows/updateSalesChannelsWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "sales-channeldeleted", children: (<>sales-channel.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.deleted" payload={`\`\`\`ts
[{
id, // The ID of the sales channel
}]
\`\`\``} />
Emitted when sales channels are deleted.
#### Payload
```ts
[{
id, // The ID of the sales channel
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteSalesChannelsWorkflow](/references/medusa-workflows/deleteSalesChannelsWorkflow)
---
## Shipping Option Type Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[shipping-option-type.updated](#shipping-option-typeupdated)
<Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when shipping option types are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[shipping-option-type.created](#shipping-option-typecreated)
<Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when shipping option types are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[shipping-option-type.deleted](#shipping-option-typedeleted)
<Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip>
</Table.Cell>
<Table.Cell>
Emitted when shipping option types are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typeupdated", children: (<>shipping-option-type.updated
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.updated" payload={`\`\`\`ts
[{
id, // The ID of the shipping option type
}]
\`\`\``} />
Emitted when shipping option types are updated.
#### Payload
```ts
[{
id, // The ID of the shipping option type
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateShippingOptionTypesWorkflow](/references/medusa-workflows/updateShippingOptionTypesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typecreated", children: (<>shipping-option-type.created
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.created" payload={`\`\`\`ts
[{
id, // The ID of the shipping option type
}]
\`\`\``} />
Emitted when shipping option types are created.
#### Payload
```ts
[{
id, // The ID of the shipping option type
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createShippingOptionTypesWorkflow](/references/medusa-workflows/createShippingOptionTypesWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typedeleted", children: (<>shipping-option-type.deleted
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.deleted" payload={`\`\`\`ts
[{
id, // The ID of the shipping option type
}]
\`\`\``} />
Emitted when shipping option types are deleted.
#### Payload
```ts
[{
id, // The ID of the shipping option type
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteShippingOptionTypesWorkflow](/references/medusa-workflows/deleteShippingOptionTypesWorkflow)
---
## User Events
### Summary
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Event
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
[user.created](#usercreated)
</Table.Cell>
<Table.Cell>
Emitted when users are created.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[user.updated](#userupdated)
</Table.Cell>
<Table.Cell>
Emitted when users are updated.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
[user.deleted](#userdeleted)
</Table.Cell>
<Table.Cell>
Emitted when users are deleted.
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
<EventHeader headerLvl="3" headerProps={{ id: "usercreated", children: (<>user.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.created" payload={`\`\`\`ts
[{
id, // The ID of the user
}]
\`\`\``} />
Emitted when users are created.
#### Payload
```ts
[{
id, // The ID of the user
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [createUsersWorkflow](/references/medusa-workflows/createUsersWorkflow)
- [createUserAccountWorkflow](/references/medusa-workflows/createUserAccountWorkflow)
- [acceptInviteWorkflow](/references/medusa-workflows/acceptInviteWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "userupdated", children: (<>user.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.updated" payload={`\`\`\`ts
[{
id, // The ID of the user
}]
\`\`\``} />
Emitted when users are updated.
#### Payload
```ts
[{
id, // The ID of the user
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [updateUsersWorkflow](/references/medusa-workflows/updateUsersWorkflow)
---
<EventHeader headerLvl="3" headerProps={{ id: "userdeleted", children: (<>user.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.deleted" payload={`\`\`\`ts
[{
id, // The ID of the user
}]
\`\`\``} />
Emitted when users are deleted.
#### Payload
```ts
[{
id, // The ID of the user
}]
```
#### Workflows Emitting this Event
The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the [Store](https://docs.medusajs.com/api/store) and [Admin](https://docs.medusajs.com/api/admin) API references.
- [deleteUsersWorkflow](/references/medusa-workflows/deleteUsersWorkflow)
- [removeUserAccountWorkflow](/references/medusa-workflows/removeUserAccountWorkflow)