Output to SMS Node Configuration Guide

The Output to SMS Node enables automated delivery of real-time alerts and workflow messages via text message (SMS). This node is ideal for critical notifications such as threshold breaches, equipment failures, or urgent workflow events.

What It Does

This node formats and sends a mobile text message (SMS) using information from your workflow payload. The message includes optional header and footer content, and a dynamic body with values from the payload. You can define recipients through user groups, hard-coded mobile numbers, or dynamically using values extracted from the payload itself.

The Output to SMS Node is especially useful for time-sensitive alerts when users are not monitoring dashboards or emails.


Step-by-Step: How to Configure the Output to SMS Node

1. Add the node

Drag the Output to SMS node onto the canvas.

2. Set the node name

Give your node a meaningful label (e.g., "Critical Temp Alert SMS").

3. Compose the SMS content

  • Header: (Optional) Text prepended at the top of the message.

  • Body: Required. This is the main content of the SMS. You can inject payload values using .

  • Footer: (Optional) Text appended at the bottom of the message.

4. Choose recipients

At least one recipient method must be configured:

  • Configure recipients in User Group: Select a predefined Rayven user group.

  • Send to mobile number (without creating user): Enter one or more mobile numbers (comma-separated, include country codes).

  • JSON key with mobile numbers: Enter the key in the payload where recipient numbers are stored (e.g., payload.alert_numbers).

5. Set the sender name

Optionally define a Sender Name that appears as the message origin (carrier-dependent; some countries may restrict this).


Configuration Fields

Field Requirement Description
Node Name* Required Name used to label the node in the canvas.
Header Optional Text added at the top of the SMS message.
Body* Required Core content of the message. Can include payload values.
Footer Optional Additional message content shown at the end.
Configure recipients in User Group Optional Send to all users in a selected Rayven group.
Send to mobile number (without creating user) Optional Direct input of one or more numbers (with country codes).
JSON key with mobile numbers Optional Path to recipient numbers in the incoming payload.
Sender Name Optional Branded sender name for the SMS (if supported by carrier).
 

Example: SMS Alert for Pump Failure

Payload Input:

json
CopyEdit
{
"device_id": "pump_7",
"status": "FAULT",
"alert_numbers": ["+61412345678", "+61498765432"]
}

Configuration:

  • Header: 🚨 Pump Alert

  • Body:

    lua
    CopyEdit
    Device has reported status: .
    Immediate attention required.
  • Footer: – Rayven Monitoring

  • JSON key with mobile numbers: alert_numbers

  • Sender Name: RayvenAlerts

Result:
An SMS is sent to both numbers with the dynamic status message, customized branding, and clear context.


Best Practices

  • Keep SMS messages short and concise (recommended: under 160 characters).

  • Always include the device name or location in the message for clarity.

  • Test dynamic values to avoid placeholder errors like if keys are missing.

  • Include country codes for international reliability.


 Use Cases

  • Send real-time alerts for temperature, pressure, or safety thresholds.

  • Notify field technicians of machine failures.

  • Broadcast workflow completion notices to mobile staff.

  • Deliver urgent, low-latency messages where emails may be overlooked.


FAQ

Q: What if multiple recipient methods are configured?
A: The message will be sent to all defined recipients across user group, static number list, and dynamic payload key.

Q: What happens if the mobile number format is incorrect?
A: The node may fail silently or return a delivery error. Always include the full international format (e.g., +61 for Australia).

Q: Can I send emojis or special characters?
A: Yes, most carriers support basic Unicode characters, but this may reduce message length limits.

Q: Is message delivery guaranteed?
A: Delivery depends on external SMS gateways and mobile networks. For critical systems, consider redundant alert paths (e.g., SMS + email).