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
| name | type | required | constraints | |
|---|---|---|---|---|
notifications | array | yes | items: notification | One or more notification payloads to send |
Notification item
- At least one of
emailConfigorsmsConfigshould be provided in practice.
| name | type | required | constraints | |
|---|---|---|---|---|
label | string | no | Optional internal label for this notification | |
emailConfig | object | no | nullable: true; if present, all properties required | Email payload to send via configured provider |
smsConfig | object | no | nullable: true; if present, all properties required | SMS payload to send via configured provider |
Email config
| name | type | required | |
|---|---|---|---|
recipients | array[string] | yes | One or more recipient email addresses |
message | string | yes | Email body content |
subject | string | yes | Email subject line |
from | string | yes | Sender email address (may be validated by provider) |
replyTo | string | yes | Reply-to email address |
attachments | array[File] | yes | Files to attach to the email |
Attachment file
| name | type | required | |
|---|---|---|---|
file | string | yes | File identifier or handle |
outputName | string | no | File name as it should appear to the recipient |
SMS config
| name | type | required | |
|---|---|---|---|
recipients | array[string] | yes | One or more E.164-formatted phone numbers |
message | string | yes | SMS 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."
}
}
]
}Updated 22 days ago
