createInvitesWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createInvitesWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more user invites. It's used by the Create Invite Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to create invites within your custom flows.
Source CodeExamples#
Steps#
Input#
CreateInvitesWorkflowInputDTOCreateInvitesWorkflowInputDTO
CreateInvitesWorkflowInputDTOCreateInvitesWorkflowInputDTOinvitesCreateInviteDTO[]The invites to create.
invitesCreateInviteDTO[]Output#
InviteDTO[]InviteDTO[]
InviteDTO[]InviteDTO[]idstringThe ID of the invite.
idstringemailstringThe email of the invite.
emailstringacceptedbooleanWhether the invite is accepted.
acceptedbooleantokenstringThe token of the invite.
tokenstringexpires_atDateThe invite's expiry date.
expires_atDatemetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>created_atDateThe invite's creation date.
created_atDateupdated_atDateThe invite's update date.
updated_atDatedeleted_atnull | DateThe invite's deletion date.
deleted_atnull | DateEmitted 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 |
|---|---|---|---|
| Emitted when invites are created. You can listen to this event to send an email to the invited users, for example. |
|