Endpoint for connecting agents with customers when an escalation is triggered
Server Address: https://api.ultimate.ai
String API Key for the botId. The key can be generated on custom CRM integration page in our Ultimate.ai Dashboard. Please see Authentication article to learn more.
The ID of the bot that is sending the event.
application/jsonAn ID provided by the custom CRM to identify the conversation. The custom CRM application can decide the format.
Text of the agent's message, if the eventType is 'message'
Agent's name, if the eventType is 'escalationSuccess'
Agent's avatar, if the eventType is 'escalationSuccess'
Queue position, if the eventType is 'escalationQueueUpdate'
Waiting time, if the eventType is 'escalationQueueUpdate'
The request has been acknowledge and will be processed. The actual response will come through webhooks.
{ "platformConversationId": "string", "eventType": "string", "text": "string", "agent": "string", "agentAvatar": "string", "queuePosition": "string", "waitingTime": "string"}