Skip to main content

Chatwoot

Integration with Chatwoot via the /chatwoot/integration endpoint allows you to configure, update and obtain integration data from a Chatwoot account. This integration is essential for integrating platforms and services with Chatwoot, a conversation-based customer support software.

Chatwoot Integration Overview

Main Features:

  1. Define Integration (POST): Configures a new integration with Chatwoot.
  2. Update Integration (PUT): Modifies the settings of an existing integration.
  3. Get Integration Data (GET): Retrieves the details of the configured integration.

Key Components of the Request:

  • baseURL: Chatwoot URL.
  • cwtoken: Chatwoot account token.
  • accountId: Chatwoot account ID.
  • inbox: Name of the Chatwoot inbox or identifier of an existing inbox.
  • message: Default message for message types not supported by Chatwoot.
  • displayAttendant: Activates the display of the attendant's name when sending messages to WhatsApp.
  • startConversationAs: Defines how a new conversation should start (pending or open).

Integration Process

  1. Initial Setup (POST): Integration is set up by submitting required details such as URL, token, account ID, inbox settings, and messaging preferences.
  2. Settings Update (PUT): Existing settings can be updated as needed.
  3. Data Query (GET): Information about the configured integration can be retrieved at any time.

Practical Use

This integration is ideal for companies and developers looking to integrate their systems with Chatwoot to manage customer service and support through conversations. It allows you to automate the creation of inboxes and the configuration of standard interactions, facilitating communications management and improving the user experience.

Documentation and Examples

Click here for endpoint documentation.

This integration with Chatwoot provides an efficient and customizable solution for integrating communication and customer support systems, optimizing conversation management and improving service.