refreshInviteTokensWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the refreshInviteTokensWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow refreshes the token of one or more user invites, updating the token and the expiry date. It's used by the Refresh Invite Token Admin API Route.
This workflow is useful to trigger resending invite tokens. It emits the invite.resent event,
which you can listen to in a Subscriber.
You can use this workflow within your customizations or your own custom workflows, allowing you to refresh invite tokens within your custom flows.
Source CodeExamples#
Steps#
Input#
ResendInvitesWorkflowInputDTOResendInvitesWorkflowInputDTO
ResendInvitesWorkflowInputDTOResendInvitesWorkflowInputDTOinvite_idsstring[]The IDs of the invites to refresh.
invite_idsstring[]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 should be resent because their token was refreshed. You can listen to this event to send an email to the invited users, for example. |
|