Chat Data icon

Chat Data

Basic Chat Data Node

Actions11

Overview

The node interacts with a chatbot service API to perform various operations related to chatbots, actions, and triggers. Specifically for the Chatbot resource and the Get Chatbot Training Status operation, it retrieves the current training status of a specified chatbot by its name or ID.

This node is useful in scenarios where you want to monitor or check the progress/status of a chatbot's training process programmatically within an n8n workflow. For example, after initiating a chatbot retraining, you can use this operation to poll and verify when the training completes or if there are any errors.

Properties

Name Meaning
Chatbot Name or ID Select a chatbot from a dropdown list loaded dynamically from the connected chatbot service, or specify a chatbot ID using an expression. This identifies which chatbot's training status to retrieve.

Output

The output JSON contains the full response from the chatbot service API regarding the training status of the specified chatbot. The structure includes fields returned by the /chatbot/status/{chatbot_id} endpoint, typically indicating whether the chatbot is currently training, completed, failed, or other relevant status details.

Example output structure (simplified):

{
  "status": "success",
  "trainingStatus": "completed",
  "lastTrainedAt": "2024-06-01T12:00:00Z",
  "chatbotId": "abc123"
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the chatbot service.
  • The node expects a base URL configured in the credentials to form API request URLs.
  • The chatbot service must expose a REST API endpoint /api/v2/chatbot/status/{chatbot_id} that returns the training status.

Troubleshooting

  • Missing Base URL or API Key: If the base URL or API key is not set correctly in the credentials, the node will throw an error indicating missing configuration.
  • Invalid Chatbot ID: Providing an invalid or non-existent chatbot ID will result in an error response from the API, surfaced as a node error.
  • API Errors: If the API returns an error status, the node throws an error with the message from the API response.
  • Network Issues: Connectivity problems to the chatbot service will cause HTTP request failures.
  • To handle errors gracefully, enable the "Continue On Fail" option in the node settings to allow workflows to proceed even if this node encounters issues.

Links and References

  • n8n Expressions Documentation
  • Refer to your chatbot service API documentation for detailed information on the /chatbot/status/{chatbot_id} endpoint and response format.

Discussion