Skip to main content

Set Integration

POST 
/api/v2/instance/:instanceId/chatwoot-integration

Set Integration

Request​

Path Parameters

    instanceId stringrequired

    ID of the instance.

Body

required

Objective:​

This endpoint is used to configure the integration between a specific instance and Chatwoot, allowing control over various aspects of the integration.

Request Body:​

  • accountId: Identifier for the Chatwoot account.

    • Type: String or Integer
    • Required

  • enabled: Determines if the integration is enabled or not.

    • Type: Boolean
    • Default: true
    • Required: No

  • chatwootURL: URL of the Chatwoot frontend.

    • Type: String (URL)
    • Required

  • chatwootAccessToken: Access token for the Chatwoot account.

    • Type: String
    • Required

  • webhookId: The registered webhook must contain the path /webhook and follow the format below.

  • inbox: Object containing inbox information.

    • name: Name of the inbox. Used if creating a new inbox.
      • Type: String
      • Required: Only if identifier is not provided.
    • identifier: Used to link an existing inbox.
      • Type: String or Integer
      • Required: Only if name is not provided.

  • integrationOptions: Object with additional integration options.

    • enabledGroup: Defines if group messages should be sent to Chatwoot.

      • Type: Boolean
      • Default: false
      • Required: No

    • displayAttendant: Enables the display of the attendant's name in the message header.

      • Type: Boolean
      • Required: No

    • startConversationAs: Determines how a new conversation should start.

      • Type: String
      • Possible Values: open, pending
      • Default: open
      • Required: No
    accountId Your chatwoot Account IDrequired
    enabled Enabledrequired

    Default value: true

    chatwootURL Chatwoot URLrequired

    Url of your chatwoot access

    chatwootAccessToken Chatwoot Access Tokenrequired

    Access token for your chatwoot account

    webhookId Webhook Idrequired

    Webhook ID that connects to the connector.

    inbox object
    name Name

    Name of the inbox that will be created

    identifier Identifier

    Enter the ID of an inbox that already exists

    integrationOptions object
    enabledGroup Enabled Grouprequired

    Default value: false

    Enables the exchange of messages with groups

    displayAttendant Display Attendantrequired

    Default value: true

    Enable the display of the attendant's name in the message caput.

    startConversationAs Start Conversation Asrequired

    Possible values: [pending, open]

    Default value: open

    Define how you will start new conversations on Chatwoot.

Responses​

Success - status: 201

Schema
    integrationId stringrequired
    enabled booleanrequired
    accountId numberrequired
    inboxId numberrequired
    chatwootURL stringrequired
    chatwootAccessToken stringrequired
    enabledGroup booleanrequired
    displayAttendant booleanrequired
    startConversationAs stringrequired

    Possible values: [pending, open]

    createdAt date-timerequired
    updatedAt date-timerequired
    deletedAt date-timerequired
    instanceInstanceId stringrequired
    Webhook object
    url Urlrequired

    Instance unique url.

    enabled Enabled

    Default value: false

    Enable or disable the url.

    webhookId stringrequired
Loading...