Notification Step

The Notification step sends one or more email or SMS messages during a workflow. Use it to confirm a submission, alert an admin, or notify a participant that their action is required. You can attach files or workflow-generated documents to email notifications.

Notifications

A Notification step contains an ordered list of notification payloads to send.

name	type	required	description
`label`	string	no	An optional internal label for this notification.
`emailConfig`	object	no	Email payload to send. See Email below.
`smsConfig`	object	no	SMS payload to send. See SMS below.

Each notification item must include exactly one of emailConfig or smsConfig — not both.

Email

name	type	required	description
`recipients`	array(string)	yes	One or more recipient email addresses.
`from`	string	yes	Sender email address.
`replyTo`	string	yes	Reply-to email address.
`subject`	string	yes	Email subject line.
`message`	string	yes	Email body content.
`attachments`	array	yes	Files to attach. See Attachments below.

Attachments

name	type	required	description
`file`	string	yes	File identifier or handle.
`outputName`	string	no	File name as it should appear to the recipient.

SMS

name	type	required	description
`recipients`	array(string)	yes	One or more E.164-formatted phone numbers.
`message`	string	yes	SMS body content (keep concise for best deliverability).

Examples

Let's start with a simple email-only notification sent when a form is submitted.

{
  "notifications": [
    {
      "label": "Submission Confirmation",
      "emailConfig": {
        "recipients": ["[email protected]"],
        "from": "[email protected]",
        "replyTo": "[email protected]",
        "subject": "New submission received",
        "message": "A new form was submitted. Please review.",
        "attachments": []
      }
    }
  ]
}

Here's an email notification with file attachments included.

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

To send an SMS instead, use smsConfig in place of emailConfig.

{
  "notifications": [
    {
      "label": "Submission Alert",
      "smsConfig": {
        "recipients": ["+15551234567"],
        "message": "We received your submission. Check your email for details."
      }
    }
  ]
}