Skip to main content

Define Integration

POST 
/chatwoot/integration

Integration​

Integrate with chatwoot by defining parameters in the request body.

It will not be necessary to perform even an action in chatwoot, the inbox settings will be created automatically.

Properties​

  • baseURL: URL of your chatwoot.

  • cwtoken: Your chatwoot account token.

  • accountId: Your chatwoot account id.

  • inbox: Your chatwoot inbox inboxName or identifier. Enter a inboxName to automatically create an inbox, or pass the inbox_identifier of an existing inbox. If both attributes are entered, the identifier attribute will be chosen.

  • message: A message that will be sent to the sender in case of message types not supported by chatwoot. Messages of the type view once, message to list, protocol messages, product messages, among other types, cannot be converted to be sent to chatwoot.

  • displayAttendant: Enable the display of the attendant's name when sending messages to WhatsApp.

  • startConversationAs: Start a conversation as pending or open.

Request​

Body

required
    baseURL BaseURLrequired

    URL of your chatwoot

    cwtoken Chatwoot Tokenrequired

    Your chatwoot account token

    accountId Accountrequired

    Your chatwoot account id

    inbox object
    inboxName Namerequired

    The inbox will be created with that name

    identifier Identifierrequired

    Existing inbox identifier

    enableGroup Enable Grouprequired

    Default value: false

    Receive group messages on chatwoot

    message Messagerequired

    Default value: Dear, this type of message cannot be analyzed by our team.

    A message that will be sent to the sender in case of message types not supported by chatwoot

    displayAttendant Display Attendant

    Default value: true

    Enables the display of the attendant's name in the whatsapp chat

    startConversationAs Start Conversation

    Default value: pending

    Start a conversation as pending or open

Responses​

Loading...