docs: generate events reference (#12341)

* docs: generate events reference

* change link in navbar

* fix redirect
This commit is contained in:
Shahed Nasser
2025-05-01 19:39:53 +03:00
committed by GitHub
parent 332e46d1db
commit 70a99a2434
94 changed files with 31164 additions and 18109 deletions
@@ -0,0 +1,55 @@
---
slug: /references/auth/events
sidebar_label: Events Reference
---
import { TypeList } from "docs-ui"
# Auth Module Events Reference
This reference shows all the events emitted by the Medusa application related to the Auth Module. If you use the module outside the Medusa application, these events aren't emitted.
## 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>
## `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
```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
- [generateResetPasswordTokenWorkflow](/references/medusa-workflows/generateResetPasswordTokenWorkflow)