Overview
This node sends messages using the BuilderBot API. It is designed to deliver text and optionally media content to specified phone numbers within a given BuilderBot project. This node is useful for automating communication workflows such as sending notifications, alerts, or marketing messages via SMS or messaging platforms supported by BuilderBot.
Practical examples:
- Sending appointment reminders to customers.
- Delivering promotional messages with images to a list of contacts.
- Notifying users about system updates or alerts.
Properties
| Name | Meaning |
|---|---|
| Project ID | The unique identifier of your BuilderBot project where the message will be sent. |
| Message Content | The text content of the message to be delivered. |
| Phone Number | The recipient's phone number to which the message will be sent. |
| Media URL | (Optional) A URL pointing to a media file (e.g., image) to include in the message. |
Output
The node outputs an array of JSON objects, each representing the response from the BuilderBot API for each message sent. The structure includes the API's response data, which may contain message status, IDs, or error information if the request failed.
If an error occurs during sending and the node is configured to continue on failure, the output JSON will contain an error field with the error message describing what went wrong.
No binary data output is produced by this node.
Dependencies
- Requires a valid API key credential for authenticating requests to the BuilderBot API.
- The node makes HTTP POST requests to the BuilderBot cloud API endpoint at
https://www.builderbot.cloud/api/v2/. - Proper network access to the BuilderBot API service is necessary.
Troubleshooting
- Missing API Key: If the API key is not provided or invalid, the node throws an error stating "API key is missing. Please check your BuilderBot API credentials."
- Authentication Failure: If the API responds with an authentication error, the node throws "Authentication failed. Please check your API key."
- Invalid Input Data: Ensure that the Project ID, phone number, and message content are correctly provided; missing required fields will cause the request to fail.
- Media URL Issues: If a media URL is provided, it must be accessible and valid; otherwise, the message might not send properly.
- Network Errors: Connectivity issues to the BuilderBot API endpoint can cause failures; verify network settings and API availability.
- When
continueOnFailis enabled, errors for individual messages do not stop execution but are returned in the output for review.
Links and References
- BuilderBot API Documentation (assumed official docs for further details)
- n8n documentation on HTTP Request Node for understanding underlying request mechanics