Integrate Toolzz Chat

Endpoint to integrate the agent to Toolzz Chat.

Request Example

curl --request POST \
  --url https://converflow.api.prod.toolzz.media/api/v1/chat/integration \
  --header 'Authorization: Bearer TOKEN_HERE' \
  --header 'Content-Type: application/json' \
  --data '
{
    "unitId": "uuid",
    "title": "string",
    "teamId": 12345678,
    "infisicalReference": {
        "secretName": "uuid"
    },
    "inboxId": 123,
    "handoffAction": "string",
    "escalationNotice": "string",
    "keepHistory": true,
    "sendInitialMessage": true
}
'

Response Example

{
    "accountId": 1,
    "inboxId": 186,
    "sendInitialMessage": true,
    "keepHistory": true,
    "isActive": true
}

Request description

Access Token

Parameter	Type	Description	Required
`Authorization`	String	Access token (“Bearer” must be before the token)	Yes

Body Parameters

Key	Type	Description	Required
`unitId`	UUID	Unique identifier of the organizational unit.	Yes
`title`	String	Identifier title of this transfer configuration.	Yes
`teamId`	Number	ID of the department/team (seen in the previous listing) where the chat will be moved.	Yes
`infisicalReference`	Object	Security reference for required API keys.	Yes
`infisicalReference.secretName`	String	ID or name of the secret in the Infisical vault (e.g., ToolzzChat credential).	Yes
`inboxId`	Number	ID of the specific inbox that will receive the conversation.	Yes
`handoffAction`	String	Prompt or command that triggers the transfer logic.	Yes
`escalationNotice`	String	Message sent to the end user informing about the transfer.	Yes
`keepHistory`	Boolean	If `true`, the conversation history with the AI will be maintained for the human attendant.	Yes
`sendInitialMessage`	Boolean	Defines if an initial automatic message should be triggered after handoff.	Yes

Response description

Key	Type	Description
`accountId`	Number	Unique identifier of the organizational account in the chat provider.
`inboxId`	Number	Specific identifier of the configured inbox (Inbox).
`sendInitialMessage`	Boolean	Indicates if sending an automatic greeting message is enabled.
`keepHistory`	Boolean	Indicates if the history of previous interactions will be preserved in this session.
`isActive`	Boolean	Current status of the configuration (`true` for active / `false` for inactive).

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

Log in to the ToolzzAI platform
Click on “Settings”
Click on “Access Token”
Copy the access token

Access token page