Skip to content

Set up a Cognigy.AI Endpoint for Handover

When you create a new Agent in Cognigy.AI you are prompted to select an Endpoint. You can select, for example, Cognigy Webchat as a specific Endpoint to the Cognigy.AI platform. For more information, see Endpoints.

If you want to integrate a Handover process in your Flow, you need to configure your Endpoint for Handover.


Before setting up the Endpoint, check whether these steps are done:

Handover Configuration

To configure the Handover Settings of your Endpoint, follow these steps:

  1. Go to the Cognigy.AI interface.
  2. In the left-side menu, select Deploy > Endpoint.
  3. Click +New Endpoint.
  4. In the New Endpoint window, add an Endpoint name and select your virtual agent Flow that hands you over to a human agent.
  5. In the Endpoint type list, select the Webchat Endpoint.
  6. Enter a unique name and click Save.
  7. Go to Handover Settings.
  8. Select Cognigy Live Agent from the Handover Platform list.

To configure your Live Agent, you have two options:

  1. You can use the pre-configured Live Agent Account for a Handover, which is mapped to the Cognigy.AI organization.
  2. You can manually configure the Live Agent handover by deactivating the Handover to pre-configured Live Agent account using the toggle switch.

Both options are described below.

Handover to pre-configured Live Agent

If the toggle switch for the Handover to pre-configured Live Agent account option is activated, conversations will be transferred to the Live Agent Account mapped to the current Cognigy.AI organization.

If you have on-premise installation, set the following environment variables in your Cognigy.AI installation:


You can find these environment variables in the value.yaml configuration file.

Handover to Manually Configured Live Agent

To configure your Live Agent manually, follow these steps:

  1. Open the Endpoint Editor and deactivate in field Handover Settings the Handover to pre-configured Live Agent account option using the toggle switch.
  2. Enter the Base URL for the Live Agent instance. The Base URL is your Live Agent installation URL, extended by plus /api/v1. For example, in the Cognigy Trial environment is the Base URL where is the Live Agent URL.
  3. Enter the Account ID and the API Key. How to find the Account ID and the API Key, see sections below.
  4. Click Save to confirm your Live Agent settings.

Your Live Agent has been configured.

Find an Account ID

You can find the Account ID in the Live Agent URL of your Live Agent Inbox.

To locate the ID, follow these steps:

  1. Open your Live Agent Account and go to Settings > Inboxes.
  2. In the Inboxes list, find the Inbox of your project, and click the Settings icon next to the Inbox.
  3. The Inbox settings will be displayed, and you will see the address line of your browser as follows: https://liveagent-<your-environment>/app/accounts/<account-id>/settings/inboxes/<inbox-id>. For example, in the URL, the Account ID is 2.

When you have found the Account ID, you can enter it in the Handover Settings of your Endpoint in Cognigy.AI.

Find an API Key

  1. Click the Profile Settings icon of your Account in the bottom-left corner of the Live Agent dashboard, then select Profile Settings in the selection menu.
  2. Find the Access Token section, showing your API Key.
  3. Copy the API Key and paste it into the API Key field of your Endpoint in Cognigy.AI.

What's Next?

When the Endpoint is configured, set up your Flow for Handover to Live Agent