sendNotificationsStep - Medusa Core Workflows Reference
This documentation provides a reference to the sendNotificationsStep. It belongs to the @medusajs/medusa/core-flows package.
This step sends one or more notifications.
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { sendNotificationsStep } from "@medusajs/medusa/core-flows"3 4const myWorkflow = createWorkflow(5 "my-workflow",6 () => {7 const data = sendNotificationsStep({8 "to": "{value}",9 "channel": "{value}",10 "template": "{value}"11 })12 }13)
Input#
SendNotificationsStepInputSendNotificationsStepInputThe notifications to send.
SendNotificationsStepInputSendNotificationsStepInputtostringThe address to send the notification to, depending on
the channel. For example, the email address for the email channel.
tostringchannelstringThe channel to send the notification through. For example, email.
channelstringemail.templatestringThe ID of the template to use for the notification. This template ID may be defined
in a third-party service used to send the notification.
templatestringdataRecord<string, unknown> | nullOptionalThe data to use in the notification template. This data may be used to personalize
the notification, such as the user's name or the order number.
dataRecord<string, unknown> | nullOptionaltrigger_typestring | nullOptionalThe type of trigger that caused the notification to be sent. For example, order_created.
trigger_typestring | nullOptionalorder_created.resource_idstring | nullOptionalThe ID of the resource that triggered the notification. For example, the ID of the order
that triggered the notification.
resource_idstring | nullOptionalresource_typestring | nullOptionalThe type of the resource that triggered the notification. For example, order.
resource_typestring | nullOptionalorder.receiver_idstring | nullOptionalThe ID of the user receiving the notification.
receiver_idstring | nullOptionaloriginal_notification_idstring | nullOptionalThe ID of the original notification if it's being resent.
original_notification_idstring | nullOptionalidempotency_keystring | nullOptionalA key to ensure that the notification is sent only once. If the notification
is sent multiple times, the key ensures that the notification is sent only once.
idempotency_keystring | nullOptionalOutput#
NotificationDTO[]NotificationDTO[]
NotificationDTO[]NotificationDTO[]idstringThe ID of the notification.
idstringtostringThe recipient of the notification. It can be email, phone number, or username, depending on the channel.
tostringchannelstringThe channel through which the notification is sent, such as 'email' or 'sms'
channelstringtemplatestringThe template name in the provider's system.
templatestringdatanull | Record<string, unknown>The data that gets passed over to the provider for rendering the notification.
datanull | Record<string, unknown>provider_idstringThe ID of the notification provider.
provider_idstringproviderNotificationProviderDTOInformation about the notification provider
providerNotificationProviderDTOcreated_atDateThe date and time the notification was created.
created_atDatestatus"pending" | "success" | "failure"The status of the notification
status"pending" | "success" | "failure"fromnull | stringOptionalThe sender of the notification. It can be email, phone number, or username, depending on the channel.
fromnull | stringOptionalOptional attachments for the notification.
trigger_typenull | stringOptionalThe event name, the workflow, or anything else that can help to identify what triggered the notification.
trigger_typenull | stringOptionalresource_idnull | stringOptionalThe ID of the resource this notification is for, if applicable. Useful for displaying relevant information in the UI
resource_idnull | stringOptionalresource_typenull | stringOptionalThe type of the resource this notification is for, if applicable, eg. "order"
resource_typenull | stringOptionalreceiver_idnull | stringOptionalThe ID of the customer this notification is for, if applicable.
receiver_idnull | stringOptionaloriginal_notification_idnull | stringOptionalThe original notification, in case this is a retried notification.
original_notification_idnull | stringOptionalexternal_idnull | stringOptionalThe id of the notification in the external system, if applicable
external_idnull | stringOptionalWas this page helpful?