Notification Step

Sends email and/or SMS notifications at any point in your workflow. Use this step to alert users, admins, or external parties about workflow events, status updates, or required actions. Supports attaching uploaded files or workflow-generated documents to emails.

Top-level properties

nametyperequiredconstraints
notificationsarrayyesitems: notificationOne or more notification payloads to send

Notification item

  • At least one of emailConfig or smsConfig should be provided in practice.
nametyperequiredconstraints
labelstringnoOptional internal label for this notification
emailConfigobjectnonullable: true; if present, all properties requiredEmail payload to send via configured provider
smsConfigobjectnonullable: true; if present, all properties requiredSMS payload to send via configured provider

Email config

nametyperequired
recipientsarray[string]yesOne or more recipient email addresses
messagestringyesEmail body content
subjectstringyesEmail subject line
fromstringyesSender email address (may be validated by provider)
replyTostringyesReply-to email address
attachmentsarray[File]yesFiles to attach to the email

Attachment file

nametyperequired
filestringyesFile identifier or handle
outputNamestringnoFile name as it should appear to the recipient

SMS config

nametyperequired
recipientsarray[string]yesOne or more E.164-formatted phone numbers
messagestringyesSMS body content (keep concise)

Example (JSON)

{
  "notifications": [
    {
      "label": "Submission Confirmation",
      "emailConfig": {
        "recipients": ["[email protected]", "[email protected]"],
        "message": "Thanks for your submission. Your receipt is attached.",
        "subject": "Submission received",
        "from": "[email protected]",
        "replyTo": "[email protected]",
        "attachments": [
          { "file": "file_123", "outputName": "Receipt.pdf" },
          { "file": "file_456", "outputName": "Details.txt" }
        ]
      },
      "smsConfig": {
        "recipients": ["+15551234567"],
        "message": "We received your submission. Check email for details."
      }
    }
  ]
}