Hooks API for Internal Transfers

This API supports internal transfer events, reducing reliance on UI socket events. It captures transfer data initiated outside the UI, sends via API payloads, and displays in the Agent AI widget.

Method	POST
Endpoint	https://{{host}}/api/v1/hooks/{{botId}}
Content Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token

Path Parameters

Parameter	Required	Description
host	Yes	The environment URL. For example, https://platform.kore.ai.
botId	Yes	Unique identifier of the bot.

Sample Request

curl --location 'https://{{host}}//agentassist/api/v1/hooks/st-3e81xxxx-4e3c-514b-a551-7d0c9c8xxxxx' \
--header 'Content-Type: application/json' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImNzLTYzNjNmY2JiLTMxMGUtNWIwNy05MWE5LWM2MTRjZDNjYmY2ZSJ9.H-JGmnWDBm2mFIw_PoMLQ5WLTPT_9-iFFPTLrHxxxxx' \
--data '{
   "conversationId": "atesta-mejwi330",
   "botId": "st-3e814314-4e3c-514b-a551-7d0c9c8xxxxx",
   "events": [
       {
           "name": "INTERNAL_TRANSFER_EVENT",
           "transfertype": "NA",
           "transition": "entry",
           "isExtAD": "true",
           "language": "language",
           "experience": "chat",
           "participant": {
               "identity": "731hssad",
               "name": "Agent ai",
               "type": "agent"
           }
       }
   ]
}'

Request Body Fields

Field	Type	Required	Description
conversationId	string	Yes	Unique identifier of the conversation.
botId	string	Yes	Unique identifier of the bot handling the transfer.
events	array	Yes	Contains the transfer event details.
transfertype	string	Yes	Specifies the type of transfer. Example values are NA, COLD, and WARM.
transition	string	Yes	Defines the transition state of the event. Common values are entry and exit.
participant	object	Yes	Contains participant details such as identity, name, and type. It helps to pass agent ID and Name.

Sample Response

if the request is successful, you get a success response (200 OK).

Send Feedback