Tidio API Essential Guide

What type of API does Tidio provide?

Tidio provides a REST API. Specifically:

Tidio's API Type

Tidio's API is designed with a focus on REST. It:

• Accepts JSON-encoded request bodies
• Returns JSON-encoded responses
• Uses standard HTTP response codes
• Employs authentication
• Utilizes standard HTTP verbs

Key Points to Consider

1. REST APIs are widely supported and easy to use, making them a good choice for web and mobile applications.

2. Tidio's API documentation is in beta, so some information may be subject to change.

3. In addition to the REST API, Tidio also offers Webhooks and a Widget SDK (tidioChatAPI).

Best Practices

1. When working with Tidio's REST API, follow standard REST conventions:

   • Use appropriate HTTP methods (GET, POST, PUT, DELETE, etc.)
   • Structure your requests and handle responses in JSON format
   • Utilize proper authentication methods as specified in the API documentation

2. Keep an eye on the Tidio API documentation for updates, as it's currently in beta.

3. Consider using the additional features like Webhooks and Widget SDK alongside the REST API for a more comprehensive integration with Tidio.

4. When building your application, ensure it can handle standard HTTP response codes and potential errors gracefully.

Does the Tidio API have webhooks?

Yes, the official Tidio API does have webhooks. Here are the key points about Tidio's webhook functionality:

Webhook Availability

Tidio offers webhooks as part of their API, allowing you to subscribe to various events and receive notifications when these events occur.

Event Types

You can subscribe to several types of events through Tidio's webhooks. The main event categories include:

1. Ticket-related events:

   • ticket.contact_replied: Triggered when a contact responds to a ticket.
   • ticket.operator_replied: Triggered when an operator responds to a ticket.
   • ticket.internal_note_added: Triggered when an internal note is added to a ticket.
   • ticket.operator_assigned: Triggered when a new operator is assigned to a ticket.

2. Conversation-related events:

   • conversation.solved_automatically: Triggered when a conversation is automatically resolved using the Automatic Solve feature.

Setting Up Webhooks

To set up webhooks in Tidio:

1. Access the Tidio panel under Settings > Developer > Webhooks.
2. Add a new webhook by providing your endpoint URL and creating a stack.
3. Select the events you want to subscribe to.
4. You can manage your webhooks by editing, disabling, or deleting them as needed.

Key Considerations

• Access to the webhook section is limited to project owners and admins.
• Webhooks are grouped into "stacks" for easier management.
• The webhook content is provided in JSON format and includes detailed information about the triggered event.
• Changes made through the OpenAPI do not trigger webhooks.

Best Practices

• Ensure your endpoint URL is secure and can handle the incoming webhook payloads.
• Implement proper error handling and logging for your webhook endpoint.
• Consider implementing authentication for your webhook endpoint to ensure the integrity of incoming data.
• Test your webhook implementation thoroughly to ensure it can handle all subscribed events correctly.

By utilizing Tidio's webhooks, you can create real-time integrations and automate workflows based on events occurring within your Tidio account.

Rate Limits and other limitations

API Rate Limits for Tidio API

The Tidio API implements rate limiting to prevent abuse and ensure the API remains available for all users. Here are the key points regarding the API rate limits:

1. Rate limits vary based on the pricing plan:

   • Free Trial: OpenAPI not available
   • Tidio Free: OpenAPI not available
   • Paid Plans: OpenAPI not available
   • Tidio+: Maximum 120 requests in 1 minute per project

2. Response headers provide information about rate limits:

   • x-ratelimit-limit: The maximum number of requests a client can make in a given period
   • x-ratelimit-remaining: The number of remaining requests a client can make before hitting the limit

3. Exceeding the rate limit results in a 429 HTTP status code:

   {
       "errors": [
           {
               "code": "too_many_requests",
               "message": "You have reached the limit of allowed attempts"
           }
       ]
   }

Key Points to Consider

• The Tidio API is only available for paid plans, specifically the Tidio+ plan.
• Rate limits are enforced on a per-project basis, not per API key or user.
• It's important to monitor the response headers to track your usage and avoid exceeding the limits.

Best Practices

1. Implement a retry mechanism with exponential backoff to handle rate limit errors gracefully.
2. Monitor your API usage using the provided response headers to stay within the limits.
3. If you consistently hit rate limits, consider optimizing your API usage or upgrading your plan if available.
4. Use the API efficiently by batching requests when possible and avoiding unnecessary calls.

Additional Information

• To use the Tidio API, you need to obtain credentials from the Tidio Panel under the Developer > OpenAPI section.
• API requests require two headers: X-Tidio-Openapi-Client-Id and X-Tidio-Openapi-Client-Secret.
• The Tidio API is designed with a focus on REST, accepting JSON-encoded request bodies and returning JSON-encoded responses.

By understanding and adhering to these rate limits, you can ensure smooth integration with the Tidio API while avoiding disruptions due to exceeding usage thresholds.

Latest API Version

Based on the search results provided, I could not find a specific mention of the most recent version of the Tidio API. The search results contain general information about Tidio's features and capabilities, but do not provide version details for their API.

However, I can provide some key points about Tidio's API and developer resources based on the information available:

Key Points:

1. Tidio offers an OpenAPI that allows creating backend connections between the Tidio application and third-party services.

2. The Tidio OpenAPI is designed with a focus on REST. It accepts JSON-encoded request bodies and returns JSON-encoded responses, using standard HTTP response codes, authentication, and verbs.

3. Tidio also provides Webhooks, which allow you to subscribe to certain Tidio events and receive notifications on your endpoint URL when an event occurs.

4. There is a Widget SDK (tidioChatAPI) available, which is a collection of frontend scripts that can control certain behaviors of the widget.

5. Tidio's developer documentation is in beta, and they are constantly working to improve and expand the capabilities of their API.

Best Practices:

1. To get the most up-to-date information about the Tidio API version, it's recommended to check the official Tidio Developers documentation.

2. When working with the Tidio API, ensure you're using the latest documentation as features and endpoints may be updated over time.

3. If you need specific version information or have questions about the API, it's best to contact Tidio support directly as they would have the most current information.

While I couldn't provide the exact version number you were looking for, I hope this information about Tidio's API offerings is helpful. For the most accurate and up-to-date information, I recommend checking Tidio's official developer documentation or contacting their support team directly.

How to get a Tidio developer account and API Keys?

To get a developer account for Tidio and create an API integration, you can follow these steps:

1. Create a Tidio account

First, you need to create a free Tidio account if you don't already have one. You can do this by visiting the Tidio website and signing up.

Creating an API integration

Once you have a Tidio account, you can start using their API:

1. Log in to your Tidio account

2. Navigate to the developer section or API documentation

3. Familiarize yourself with the available APIs:

   • OpenAPI: For creating backend connections between Tidio and third-party applications
   • Webhooks: For subscribing to Tidio events and receiving notifications
   • Widget SDK: For customizing the behavior of the Tidio widget on your website

4. Generate API keys or authentication tokens as required

5. Start integrating Tidio with your application using the provided documentation and examples

Best practices:

• Read the API documentation thoroughly before starting your integration
• Use the appropriate API based on your needs (OpenAPI, Webhooks, or Widget SDK)
• Follow REST principles when working with the OpenAPI, as it's designed with a focus on REST
• Ensure you handle authentication and use HTTPS for secure communication
• Test your integration thoroughly in a development environment before deploying to production

Remember that Tidio's API documentation is in beta, so some information may be subject to change. It's a good idea to stay updated with any announcements or changes to the API.

If you need more advanced integrations or custom solutions, Tidio offers a Tidio+ plan that enables integration with almost any app available on the market. Their implementation specialists can help you achieve more complex integrations.

By following these steps and best practices, you should be able to create a developer account and start working with Tidio's API integration capabilities.

What can you do with the Tidio API?

Based on the search results provided, here are the key data models that can be interacted with using the Tidio API, along with bullet points outlining what is possible for each:

OpenAPI

• Create backend connections between Tidio and third-party applications
• Accepts JSON-encoded request bodies
• Returns JSON-encoded responses
• Uses standard HTTP response codes, authentication, and verbs
• Designed with a focus on REST principles

Webhooks

• Subscribe to specific Tidio events
• Receive notifications on your endpoint URL when subscribed events occur
• Allows real-time data synchronization and automation

Widget SDK (tidioChatAPI)

• Collection of frontend scripts to control widget behavior
• Enables better tracking of users
• Allows adding custom triggers for chatbots
• Provides functionality to customize the chat widget experience

Chatbots

• Create and manage chatbots without coding required
• Use premade chatbot templates for sales, lead generation, and ecommerce
• Implement NLP (Natural Language Processing) capabilities
• Create FAQ-based chatbots
• Build chatbot conversation flows using a drag-and-drop interface
• Deploy chatbots across multiple channels (web and social media)

Live Chat

• Manage real-time conversations with visitors
• Access a shared inbox for team collaboration
• View and interact with a visitors list
• Analyze chat performance and metrics

Help Desk

• Create and manage support tickets
• Handle multichannel support inquiries
• Integrate with live chat functionality

Analytics

• Monitor performance of team members
• Track AI chatbot effectiveness
• Analyze automation flows performance

While the search results don't provide an exhaustive list of all data models, these appear to be the main areas where the Tidio API allows interaction and management. The API seems to offer a comprehensive set of tools for managing customer interactions, chatbots, and support processes.