Chat Data icon

Chat Data

Basic Chat Data Node

Actions7

Overview

This node interacts with a chatbot service API to perform various operations related to chatbots and their actions. Specifically, the Get Chatbot Training Status operation retrieves the current training status of a specified chatbot by its name or ID. This is useful for monitoring whether a chatbot has completed training, is in progress, or encountered issues during training.

Common scenarios include:

  • Automating workflows that depend on chatbot readiness before sending messages.
  • Monitoring chatbot training progress as part of a deployment pipeline.
  • Triggering notifications or further actions based on the chatbot's training state.

Example: After initiating a chatbot retraining process, use this operation to periodically check if the training has finished successfully before enabling the chatbot for live interactions.

Properties

Name Meaning
Chatbot Name or ID Select a chatbot from the dropdown list or specify its ID via an expression. This identifies which chatbot's training status to retrieve.

Output

The output JSON contains the full response from the chatbot service's /chatbot/status/{chatbot_id} endpoint. It typically includes fields indicating the training status, such as whether training is complete, in progress, or failed, along with any relevant metadata about the chatbot.

The output structure is:

{
  "status": "success" | "error",
  "trainingStatus": "...",        // e.g., "completed", "in_progress", "failed"
  "lastTrainedAt": "...",         // timestamp or date string
  "chatbotId": "...",
  "message": "..."                // optional message or error description
}

If the node encounters an error, it throws an error with the message returned by the API or a descriptive error message.

Dependencies

  • Requires an API key credential configured with the chatbot service.
  • The credential must include a base URL for the chatbot API.
  • The node uses HTTP requests authenticated with a bearer token (API key).
  • The chatbot service must expose a REST API endpoint at /api/v2/chatbot/status/{chatbot_id}.

Troubleshooting

  • Missing Base URL in Credentials: If the base URL is not set in credentials, the node will throw an error instructing to configure it properly.
  • Invalid Chatbot ID: Providing an incorrect or non-existent chatbot ID will result in an error response from the API.
  • API Errors: If the API returns a status of "error", the node surfaces the error message. Check the API key validity and permissions.
  • Network Issues: Connectivity problems to the chatbot API endpoint will cause request failures.
  • Response Format Issues: Unexpected response formats may cause errors; ensure the chatbot API version matches expectations.

To resolve errors:

  • Verify API credentials and base URL.
  • Confirm the chatbot ID exists and is correct.
  • Check network connectivity.
  • Review API documentation for any changes in endpoints or response formats.

Links and References

  • n8n Expressions Documentation
  • Chatbot Service API Documentation (refer to your chatbot provider's official API docs for /chatbot/status endpoint)
  • n8n HTTP Request Node Documentation (for understanding HTTP request handling)

Discussion