Chatwoot

Overview

This node interacts with the Chatwoot API to manage webhooks within a specified account. The "Webhook - Get" operation retrieves details of a specific webhook by its numeric ID for a given account. This is useful when you want to fetch configuration or status information about an existing webhook in your Chatwoot account.

Common scenarios:

• Auditing or verifying webhook configurations.
• Fetching webhook details before updating or deleting it.
• Integrating webhook data into workflows for monitoring or reporting.

Practical example:
You have multiple webhooks set up for different event notifications in Chatwoot, and you want to retrieve the details of a particular webhook to check its URL and subscribed events before making changes or triggering other automation steps.

Properties

Output

The output contains a JSON object representing the webhook's details as returned by the Chatwoot API. This typically includes fields such as the webhook's ID, URL, subscribed events, creation date, and other metadata related to the webhook configuration.

Example structure of json output (fields may vary):

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

No binary data is output by this operation.

Dependencies

• Requires an API key credential for authenticating with the Chatwoot API.
• The node makes HTTP requests to the Chatwoot API base URL configured in the credentials.
• Proper permissions on the Chatwoot account to read webhook details are necessary.

Troubleshooting

• Common issues:

  • Invalid or missing Account ID or Webhook ID parameters will cause errors.
  • Authentication failures due to incorrect or expired API keys.
  • Network connectivity issues preventing access to the Chatwoot API.
  • Attempting to get a webhook that does not exist or belongs to another account.

• Error messages and resolutions:

  • "404 Not Found": The webhook ID does not exist under the specified account. Verify IDs.
  • "401 Unauthorized" or "403 Forbidden": Check API key validity and permissions.
  • "Request failed" or timeout errors: Ensure network connectivity and correct base URL.
  • If "Continue on Fail" is false, the node execution will stop on error; setting it true allows processing remaining items.

Links and References

• Chatwoot API Documentation - Webhooks
• n8n Documentation - Creating Custom Nodes
• Chatwoot Official Website