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
Overview
This node operation allows you to create a webhook subscription for an account in the ChatWoot system. By creating a webhook, you specify a URL where event notifications will be sent whenever subscribed events occur. This is useful for integrating ChatWoot with other systems or services that need to react to real-time events such as new messages, conversations, or agent activities.
Common scenarios include:
- Automatically syncing ChatWoot events with a CRM or ticketing system.
- Triggering workflows or alerts in external applications when specific ChatWoot events happen.
- Logging or auditing ChatWoot activity externally.
Example: You want to receive notifications on your server whenever a new conversation is created in a particular ChatWoot account. You create a webhook with the URL of your server and subscribe to the "conversation_created" event.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account for which the webhook should be created. |
| Url | The destination URL where ChatWoot will send event payloads when subscribed events occur. |
| Subscriptions | A JSON array specifying the list of event types you want to subscribe to (e.g., message_created, conversation_resolved). |
Output
The node outputs JSON data representing the response from the ChatWoot API after creating the webhook. This typically includes details about the newly created webhook such as its ID, associated account, subscribed events, and the target URL.
No binary data output is involved in this operation.
Dependencies
- Requires an active ChatWoot API authentication token configured in n8n credentials.
- The node uses the ChatWoot REST API endpoint specified by the user's credentials.
- Network connectivity to the ChatWoot instance is necessary.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error. Verify the account ID before running the node.
- Malformed Subscriptions JSON: The subscriptions property expects valid JSON. Invalid JSON syntax will cause parsing errors. Ensure the JSON array is correctly formatted.
- URL Not Reachable: If the webhook URL is invalid or unreachable, events will fail to deliver. Confirm the URL is accessible and accepts POST requests.
- Authentication Errors: Missing or invalid API credentials will prevent webhook creation. Check that the API key/token is correctly set up in n8n.
- API Rate Limits: Excessive webhook creation attempts may hit rate limits imposed by ChatWoot. Respect API usage policies.
Links and References
- ChatWoot Webhooks Documentation
- ChatWoot API Reference
- n8n Webhook Node Documentation (for general webhook concepts)