acceptInviteWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the acceptInviteWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow accepts an invite and creates a user. It's used by the Accept Invite Admin API Route.

The workflow throws an error if the specified token is not valid. Also, the workflow requires an auth identity to be created previously. You can create an auth identity using the Retrieve Registration JWT Token API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to accept invites within your custom flows.

Source Code

Examples#

Steps#

validateTokenStep

createUsersWorkflow

setAuthAppMetadataStep

deleteInvitesStep

emitEventStep

Workflow hook

Step conditioned by when

View step details

Input#

AcceptInviteWorkflowInputDTOAcceptInviteWorkflowInputDTO

invite_tokenstring

The invite token.

auth_identity_idstring

The ID of the auth identity to associate the user with.

userobject

The user to create.

Output#

UserDTO[]UserDTO[]

idstring

The ID of the user.

emailstring

The email of the user.

first_namenull | string

The first name of the user.

last_namenull | string

The last name of the user.

avatar_urlnull | string

The avatar URL of the user.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

created_atDate

The creation date of the user.

updated_atDate

The updated date of the user.

deleted_atnull | Date

The deletion date of the user.

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

Event	Description	Payload	Action
`user.created`	Emitted when users are created.	`[{ id, // The ID of the user }]`
`invite.accepted`	Emitted when an invite is accepted.	`{ id, // The ID of the invite }`

Was this page helpful?