Chat Data icon

Chat Data

Basic Chat Data Node

Actions8

Action → Append a Message

AI-generated

Overview

This node operation appends a message to an existing conversation in a chatbot system. It is useful for adding new messages from either a human agent or a bot to ongoing conversations, enabling real-time chat updates and interaction logging. For example, customer support agents can use this to send responses to users, or automated bots can append system-generated replies.

Use Case Examples

  1. Appending a message from a human agent with their name and avatar to a live chat conversation.
  2. Appending a bot-generated message to a conversation to provide automated assistance or information.

Properties

Name Meaning
Chatbot Name or ID The identifier of the chatbot to which the message will be appended. This can be selected from a list or specified via an expression.
Conversation ID The ID of the existing conversation where the message will be sent.
Message The text content of the message to append to the conversation.
Sender Type Indicates whether the message is sent by a human agent or a bot. This affects how the message is labeled in the conversation.
Agent Name The name of the human agent sending the message. Used only if the sender type is human. Defaults to the chatbot owner's name if not provided.
Agent Avatar URL URL to the avatar image for the human agent. Used only if the sender type is human. Defaults to the chatbot owner's avatar if not provided.
File Attachments Optional files to attach to the message, with a maximum of 3 files. Each file requires a name, MIME type, and a public URL.

Output

JSON

  • output - The response from the chatbot API after appending the message, including status and any relevant data.

Dependencies

  • An API key credential for authenticating requests to the chatbot API, including a base URL and API key.

Troubleshooting

  • Ensure that the Chatbot ID and Conversation ID are provided and valid; missing these will cause errors.
  • Message text must not be empty or whitespace only; otherwise, an error is thrown.
  • No more than 3 file attachments are allowed; exceeding this limit will cause an error.
  • Each file attachment must have a name, type, and URL; missing any of these fields will cause an error.
  • API errors are returned with messages that should be checked for troubleshooting.
  • If the node is set to continue on fail, errors will be included in the output JSON for each item instead of stopping execution.

Discussion