Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
Messages API → Create A Message
AI-generatedOverview
This node integrates with the Messages API of a messaging platform to create and send new messages within existing conversations. It is useful in scenarios where automated or programmatic message sending is required, such as customer support chatbots, notification systems, or workflow automations that need to interact with users via messaging channels.
For example, you can use this node to:
- Send a follow-up message to a customer after a support ticket update.
- Automate sending alerts or reminders through a messaging inbox.
- Integrate with CRM systems to send personalized messages based on contact data.
Properties
| Name | Meaning |
|---|---|
| Inbox Identifier | The unique identifier of the inbox channel where the message will be sent. |
| Contact Identifier | The unique source ID of the contact who will receive the message. |
| Conversation Id | The numeric ID of the conversation thread where the message should be posted. |
| Content | The textual content/body of the message to be sent. |
| Echo Id | A temporary identifier used for tracking the message, which will be echoed back via websockets for correlation purposes. |
Output
The node outputs JSON data representing the response from the Messages API after creating the message. This typically includes details about the newly created message such as its ID, timestamps, status, and any metadata returned by the API.
If the API supports binary data (e.g., attachments), the node would handle it accordingly, but based on the provided properties and code, the primary output is JSON message data.
Dependencies
- Requires an API key credential for authenticating with the messaging platform's API.
- Needs the base URL of the API endpoint configured in the node credentials.
- Depends on the external Messages API service being available and accessible.
Troubleshooting
- Missing Required Fields: Ensure that Inbox Identifier, Contact Identifier, and Conversation Id are provided; otherwise, the API call will fail.
- Invalid Identifiers: Using incorrect or outdated identifiers may result in errors like "Conversation not found" or "Contact does not exist."
- Authentication Errors: Verify that the API key or authentication token is valid and has sufficient permissions.
- Network Issues: Check connectivity to the API endpoint if requests time out or fail.
- Echo Id Usage: If using Echo Id for websocket correlation, ensure your websocket listener is properly set up to receive echoed messages.
Common error messages usually relate to invalid parameters or authentication failures and can be resolved by verifying input values and credentials.
Links and References
- ChatWoot API Documentation
- Messages API Reference (for detailed message creation endpoints)
- n8n Documentation on Creating Custom Nodes