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.

Examples#

Steps#

Input#

Output#

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.

[{
  id, // The ID of the invite
}]