The Handover Providers section in the Endpoint settings has been deprecated in 4.97. The removal date is September 2025.
We encourage you to try our new Handover Providers interface, which offers greater flexibility for managing your integration with contact centers.
For a smooth migration, refer to the migration guide.
Prerequisites
- Familiarity with the Socket.IO library.
- Setup of the Cognigy Socket.IO client.
Generic Endpoint Settings
Learn about the generic Endpoint settings on the following pages:- Endpoints Overview
- NLU Connectors
- Data Protection & Analytics
- Transformer Functions
- Real-Time Translation Settings
- Handover Settings
- Inject and Notify
How to Set Up
Setup on the Cognigy.AI Side
1. Configure a Socket.IO Endpoint
1. Configure a Socket.IO Endpoint
- In the left-side menu of your Project, click Deploy > Endpoints.
- On the Endpoints page, click + New Endpoint.
-
In the New Endpoint section, do the following:
- Select the Socket.IO Endpoint type.
- Specify a unique name.
- Select a Flow from the list. Save changes.
-
In the Endpoint editor, go to the Configuration Information section and copy the URL from the Endpoint URL field.
The Endpoint URL consists of two parts separated by a slash:
- The server address (
<Socket-Endpoint-URL>
), for example,https://endpoint-trial.cognigy.ai
. - The token (
<URLToken>
) that comes after the slash, for example,0e77b9a19f33cb68b3f528b3b28d4b32386162559160ceb9ec85036d83dd8f8b
.
- The server address (
Setup on the Third-Party Provider Side
1. Send a Request
1. Send a Request
- Cognigy Socket.IO client
- Other clients
2. Get a Response
2. Get a Response
Messages can be received by listening to the
output
event. The responses have the following format:- Cognigy Socket.IO client
- Other clients