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. The node can target either a lead (an individual recipient) or an entire organization, making it flexible for different notification scenarios.
Common use cases include:
- Sending automated SMS alerts or reminders to leads based on workflow triggers.
- Broadcasting SMS notifications to an organization using predefined templates.
- Integrating SMS communication into workflows for marketing, customer support, or operational updates.
For example, you might use this node to send appointment reminders to customers (leads) or notify all members of an organization about system maintenance.
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; used internally for API requests. |
| Use Sms Template? | Boolean option to choose between sending a predefined SMS template (true) or a custom message (false). |
| Send To Lead? | Boolean indicating whether to send the SMS to a lead (true) or to the organization (false). |
| SMS Template | Dropdown list of available SMS templates loaded dynamically from the API; shown only if "Use Sms Template?" is true. |
| Message | Text area for entering a custom SMS message; shown only if "Use Sms Template?" is false. |
| APIKey | Hidden field that takes the API key from environment variables; used for authenticating API requests. |
Output
The node outputs JSON data representing the response from the 97Display notification API after attempting to send the SMS. Each output item corresponds to one input item and contains the full API response in its json property.
If an error occurs during sending and the node is configured to continue on failure, the output will contain an error field with the error message instead.
No binary data is produced by this node.
Dependencies
- Requires access to the 97Display notification API endpoint at
https://notificationapitest.api97.com. - Needs a valid API key credential provided via an environment variable (e.g.,
MY_API_KEY). - The node dynamically loads SMS templates from the API based on the current workflow ID.
- Proper webhook integration is expected to supply phone numbers and organization IDs in incoming data.
Troubleshooting
- Failed to load SMS templates: If the node cannot retrieve templates, it returns a default option indicating failure. Check API key validity and network connectivity.
- API request errors: Errors during SMS sending are caught and can be output as error messages if "Continue On Fail" is enabled. Common issues include invalid API keys, missing phone numbers, or malformed request bodies.
- Missing phone number: The node expects the phone number to be present in the webhook payload under
body.Phone. Ensure this data is correctly passed to avoid empty recipient errors. - Template parsing errors: When using templates, the node attempts to parse the selected template JSON. Invalid JSON or unexpected formats may cause failures.
- Environment variable not set: The API key is read from an environment variable. Make sure it is properly configured in n8n settings.
Links and References
- 97Display Notification API Documentation (assumed base URL)
- n8n documentation on Using Credentials and Environment Variables
- General info on SMS Messaging Best Practices (for conceptual understanding)