Actions113
- 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
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response Actions
Overview
This node operation allows you to create a webhook in the ChatWoot system. A webhook is a user-defined HTTP callback that triggers when specific events occur, sending event data to a specified URL. This operation is useful for integrating ChatWoot with other systems or services by receiving real-time notifications about events such as new messages, conversations, or agent activities.
Practical examples include:
- Automatically forwarding chat events to a CRM system.
- Triggering workflows in automation platforms when certain chat events happen.
- Logging chat activity externally for analytics or auditing purposes.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account where the webhook will be created. |
| Url | The destination URL where the webhook events should be sent. |
| Subscriptions | A JSON array specifying the events to subscribe to; these are the types of events that will trigger the webhook. |
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, subscribed events, target URL, and status.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The node uses the base URL provided in the credentials to send requests.
- The ChatWoot API must be accessible from the n8n environment.
Troubleshooting
- Invalid Account Id: If the account ID is incorrect or does not exist, 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 Issues: The webhook URL must be reachable and accept POST requests. If the URL is invalid or unreachable, webhook delivery will fail.
- Authentication Errors: Missing or invalid API credentials will prevent the node from successfully creating the webhook. Confirm that the API key is correct and has sufficient permissions.
- API Rate Limits: Excessive webhook creation requests may hit rate limits imposed by ChatWoot. Implement retry logic or backoff if needed.
Links and References
- ChatWoot Webhooks Documentation (for detailed API info)
- Webhook Concepts (general overview of webhooks)