N8N Tools - Tidio API icon

N8N Tools - Tidio API

Complete Tidio integration - Live chat, AI chatbots, and customer engagement

Actions31

Conversation → Create Conversation

AI-generated

Overview

The "Create Conversation" operation in this node allows you to start a new chat conversation with a visitor in the Tidio live chat system. This is useful for initiating direct communication sessions with website visitors, enabling customer support agents or automated systems to engage users proactively.

Common scenarios include:

  • Automatically starting a chat session when a visitor lands on a webpage.
  • Creating conversations triggered by external events or workflows.
  • Tagging and prioritizing conversations upon creation to streamline support handling.

For example, you might create a conversation for a visitor identified by their unique ID, assign tags like "new-lead", set the department responsible for the chat, and define the priority level to ensure timely responses.

Properties

Name Meaning
Visitor ID The unique identifier of the visitor to start the conversation with.
Additional Fields Optional extra parameters to customize the conversation:
- Visitor Name Name of the visitor (optional).
- Visitor Email Email address of the visitor (optional).
- Visitor Phone Phone number of the visitor (optional).
- Tags Comma-separated list of tags to assign to the conversation (e.g., "support,urgent").
- Tag Name Name of a single tag to add or remove (not typically used in creation).
- Custom Properties JSON object of custom properties to attach to the visitor or conversation.
- Contact Name Full name of the contact associated with the visitor (optional).
- Contact Email Email address of the contact (optional).
- Contact Phone Phone number of the contact (optional).
- Mailing List ID ID of a mailing list to associate with the contact (optional).
- Bot Flow ID ID of a chatbot flow to trigger automatically after conversation creation (optional).
- Status Operator status; options are Online, Offline, Away (default is Online).
- Department Department name or ID to assign the conversation to (optional).
- Priority Priority level of the conversation; options are Low, Normal, High, Urgent (default is Normal).
- Limit Maximum number of results to return (not applicable for creation).
- Offset Number of results to skip (not applicable for creation).
- Auto Reply Enable automatic replies (boolean, optional).
- Send As Bot Whether messages should be sent as a bot rather than an operator (boolean, optional).

Output

The output of the "Create Conversation" operation is a JSON object representing the newly created conversation resource returned by the Tidio API. This typically includes details such as:

  • Conversation ID
  • Visitor ID
  • Tags assigned
  • Department and priority settings
  • Status and timestamps
  • Any other metadata related to the conversation

The output is structured as a JSON object under the json field of the node's output data. There is no binary data output for this operation.

Dependencies

  • Requires an active Tidio API credential configured in n8n, including:
    • API key credential for authentication.
    • Client ID and Client Secret for API access.
  • The node communicates with the Tidio API endpoint specified in the credentials.
  • No additional external dependencies beyond the Tidio API and n8n environment.

Troubleshooting

  • Invalid Visitor ID: If the visitor ID is missing or incorrect, the API will fail to create a conversation. Ensure the visitor ID exists in Tidio.
  • Authentication Errors: Incorrect or expired API credentials will cause authorization failures. Verify that the API key, client ID, and secret are correct.
  • Invalid Field Values: Providing invalid tags, priority, or department values may result in errors. Use only supported values as per the property definitions.
  • JSON Parsing Errors: Custom properties must be valid JSON objects. Malformed JSON will cause request failures.
  • API Rate Limits: Excessive requests may be throttled by Tidio. Implement error handling and retries if needed.

Common error messages usually indicate missing required fields, unauthorized access, or invalid parameter formats. Review the error message details and adjust input accordingly.

Links and References

Discussion