Overview
This node sends SMS notifications using the 97Display notification API. It supports sending messages either by selecting a predefined SMS template or by composing a custom message directly. This flexibility makes it useful for automating SMS alerts, reminders, or marketing messages within workflows.
Common scenarios:
- Sending transactional SMS notifications based on workflow events.
- Using predefined SMS templates to maintain consistent messaging.
- Sending custom SMS messages when templates are not applicable.
- Integrating SMS notifications into business automation processes.
Practical example:
A workflow triggers when a new order is placed. The node sends an SMS confirmation to the customer using a selected SMS template that includes order details. Alternatively, if no template fits, a custom message can be composed and sent.
Properties
| Name | Meaning |
|---|---|
| Organization ID | Hidden field automatically populated from webhook data; identifies the organization context. |
| Workflow ID | Hidden field set to the current workflow's ID. |
| Use Sms Template? | Boolean option to choose between sending an SMS via a template (true) or a custom message (false). |
| SMS Template | Dropdown list of available SMS templates loaded dynamically from the API; required if using template. |
| To | Phone number to send the SMS to; required if not using a template. |
| Message | Custom SMS message content; required if not using a template. |
| APIKey | Hidden field containing the API key, sourced from environment variables for authentication. |
Output
The node outputs JSON data representing the response from the 97Display notification API after attempting to send the SMS. Each item in the output corresponds to one input item processed.
The JSON structure typically contains information about the success or failure of the SMS sending operation as returned by the API.
No binary data output is produced by this node.
Dependencies
- Requires access to the 97Display notification API endpoint at
https://notificationapitest.api97.com. - Needs an API key credential provided via environment variable (
apikey). - The node dynamically loads SMS templates from the API using the workflow ID.
- Proper network connectivity and valid credentials are necessary for successful API calls.
Troubleshooting
- Error loading templates: If the node fails to load SMS templates, it will show an error option in the template dropdown. Ensure the API key is valid and the workflow ID is correct.
- API request failures: Errors during SMS sending (e.g., invalid phone number, unauthorized) will cause the node to throw errors unless "Continue On Fail" is enabled, in which case error details are included in the output JSON.
- Invalid template JSON: When using a template, the node expects the template parameter to be a JSON string with
id,subject, andbody. Malformed JSON may cause parsing errors. - Missing required fields: If required properties like "To" or "Message" are empty when not using a template, the node will fail.
- Environment variable missing: The API key must be set in environment variables; otherwise, authentication will fail.
Links and References
- 97Display Notification API Documentation (assumed base URL)
- n8n documentation on Creating Custom Nodes
- General SMS best practices and formatting guidelines (varies by region/provider)