Chatwoot icon

Chatwoot

Interact with Chatwoot API

Actions35

Overview

This node allows you to create a new webhook in the Chatwoot platform for a specified account. A webhook is a user-defined HTTP callback that is triggered by specific events occurring within the Chatwoot system, such as contact creation or message creation. When these events happen, Chatwoot sends an HTTP POST request with event data to the configured URL.

Use cases include:

  • Integrating Chatwoot events with external systems like CRMs, analytics platforms, or notification services.
  • Automating workflows based on real-time updates from Chatwoot (e.g., triggering alerts when a new conversation is created).
  • Synchronizing Chatwoot data with other applications by listening to relevant events.

For example, you can create a webhook that listens for "Message Created" events and forwards them to your internal messaging system for further processing.

Properties

Name Meaning
Account ID The numeric ID of the Chatwoot account where the webhook will be created.
URL The destination URL where webhook event payloads will be sent via HTTP POST requests.
Events The list of Chatwoot events to listen for. Options: Contact Created, Contact Updated, Conversation Created, Conversation Updated, Message Created.
Continue on Fail Whether the node should continue executing subsequent items if this operation fails.

Output

The output contains a JSON object representing the newly created webhook resource as returned by the Chatwoot API. This typically includes details such as the webhook's unique ID, the URL, subscribed events, creation timestamp, and status.

Example structure of the json output field:

{
  "id": 123,
  "url": "https://example.com/webhook",
  "events": [
    "contact_created",
    "message_created"
  ],
  "created_at": "2024-01-01T12:00:00Z",
  "updated_at": "2024-01-01T12:00:00Z",
  "account_id": 1
}

No binary data is output by this node.

Dependencies

  • Requires an active Chatwoot account and valid API authentication credentials configured in n8n.
  • The node makes HTTP requests to the Chatwoot API endpoint associated with the provided account.
  • The target webhook URL must be accessible and able to receive HTTP POST requests from Chatwoot.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID: Ensure the numeric account ID is correct and the authenticated user has access.
    • Invalid webhook URL: The URL must be a valid, reachable HTTPS endpoint.
    • No events selected: At least one event must be chosen to create a webhook.
    • Network connectivity issues between n8n and Chatwoot API or between Chatwoot and the webhook URL.

  • Error messages:

    • API errors may return messages indicating invalid parameters or authentication failures. Verify API credentials and input values.
    • If the node throws an error about failing to create the webhook, check the webhook URL and event selections.
    • If "Continue on Fail" is false, the workflow will stop on error; enabling it allows processing remaining items despite failures.

Links and References

Discussion