Chat Data icon

Chat Data

Basic Chat Data Node

Overview

This node acts as an integration point for a chatbot platform, enabling workflows to react to new chat messages via a webhook trigger. Specifically, the "On New Message" operation under the "Trigger" resource listens for incoming chat messages from a selected chatbot and triggers the workflow when such messages arrive.

Common scenarios where this node is beneficial include:

  • Automating responses or follow-up actions when a user sends a message to a chatbot.
  • Logging or processing chat interactions in real-time.
  • Integrating chatbot conversations with other systems like CRMs, ticketing tools, or analytics platforms.

For example, a customer support team could use this node to automatically create support tickets whenever a new message arrives in their chatbot, ensuring timely handling of customer inquiries.

Properties

Name Meaning
Chatbot Name or ID Select the chatbot from a list or specify its ID using an expression. This determines which chatbot's new messages will trigger the workflow.
Webhook Hidden property representing the webhook identifier; set internally to "default".
Options Collection of optional settings:
  Enable Webhook Debug Boolean flag to enable additional logging for webhook debugging purposes.

Output

The output of this trigger node consists of JSON data representing the new chat message received from the chatbot. The structure mirrors the webhook payload sent by the chatbot platform and includes all relevant details about the message event.

Specifically:

  • The json field contains the parsed webhook body as an object.
  • This data can include message content, sender information, timestamps, and any other metadata provided by the chatbot service.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the chatbot platform's API.
  • The node depends on the chatbot platform's webhook system to send new message events.
  • The base URL of the chatbot API must be configured in the credentials.
  • The node registers and manages a webhook URL dynamically with the chatbot platform to receive events.

Troubleshooting

  • Webhook registration failure: If the node cannot register the webhook, ensure that the API key and base URL are correctly configured and that the chatbot ID is valid.
  • Invalid chatbot selection: Selecting a non-existent chatbot or providing an incorrect chatbot ID will prevent the trigger from working.
  • Missing or malformed webhook payloads: The node expects JSON payloads; if the chatbot platform sends unexpected formats, the node may fail to parse the data.
  • Debugging: Enable the "Enable Webhook Debug" option to get more detailed logs for troubleshooting webhook issues.
  • Credential errors: Errors related to missing or invalid credentials will prevent API calls and webhook management.

Links and References

Discussion