Skip to main content
RingCentral Engage handover provider logo

Description

The RingCentral Engage handover provider bridges Cognigy and RingCentral Engage, enabling end users to connect with human agents working in a contact center that uses RingCentral Engage.

Prerequisites

Configuration on the handover provider side

  1. Go to the ADMIN section in the top bar of the RingCentral Engage platform.
  2. Select API access tokens from the left sidebar.
  3. Click + in the top-right corner to create a new API Access Token.
  4. Select an agent to handle user chats.
  5. Copy the token text displayed next to the API Access Token name. Save it for later use.
  1. In the ADMIN section, go to Categories in the left sidebar.
  2. Click the + button to create a new category, for example, Cognigy, leave other fields as default, and save changes.
  3. Create two subcategories, Bot and Agent, with Cognigy as the parent category.
  4. Double-click Bot or Agent to open their configuration pages. Extract the CATEGORY_ID from the URL, for example, xxxxx.engagement.dimelo.com/admin/categories/CATEGORY_ID/edit. These are needed for the Bot category ID and Agent category ID fields in the Cognigy handover provider.
  1. Navigate to Sources in the ADMIN section sidebar.
  2. Create a new source of type Engage Digital Source SDK.
  3. Set the Base URI field to <endpoint-url>/handover/rce. For example, https://endpoint-dev.cognigy.ai/handover/rce.
  4. In Message Settings, set the default category to the Bot category created earlier.
  5. Copy the API access token field value from the source into the RingCentral Engage access token field of the Authentication connection in Cognigy.
  6. Copy the Realtime Endpoint URL from the Implementation Details section into the RingCentral Engage URL field of the Cognigy handover provider.
  1. In the Agents overview, click the key icon for each agent who uses the source.
  2. Grant read and reply permissions for the source.
  1. Go to Webhooks in the ADMIN section sidebar.
  2. Click the + button to create a new webhook.
  3. In the SETTINGS section:
    1. Select the previously created API Access Token.
    2. Set Active to on.
    3. Set URL to <endpoint-url>/handover/rce, for example, https://endpoint-demo.cognigy.ai/handover/rce.
    4. Enter a randomly generated value in the Secret field. Copy this value for the Webhook secret field in Cognigy.
  4. In the FILTERS section:
    1. Set Sources filtering strategy to No sources except.
    2. Select the previously created source.
  5. In the SUBSCRIPTIONS section, add the intervention.closed event.
  6. Update the Verification Token to match your Cognigy environment’s token. By default, the value is cognigy123. Save changes.
Build the API base URL by appending api to your RingCentral Engage environment name, for example, cognigy.engagement.dimelo.com becomes cognigy.api.engagement.dimelo.com. Save it for later use as the API base URL in Cognigy.
  1. Go to the Identities page in RingCentral Engage.
  2. Locate the Bot identity, check Controlled identity, and save. This ensures Bot messages appear on the right side.
  3. Locate the Agent identity, make it controlled, and assign it to agents via the Agents view by selecting the community and Agent user and saving it.
  1. Go to Desks > Folders in RingCentral Engage.
  2. Create a folder filtering chats with the Agent category for easy agent access.

Configuration on the Cognigy side

This feature is in beta. We encourage you to try it out and provide us with feedback.
  1. Go to Deploy > Handover Providers and click + Create handover provider.
  2. In the Create handover provider dialog, select RingCentral Engage and click Create handover provider. The handover provider editor opens.
  3. In the handover provider editor, configure the following:
  1. Click Save changes.
  1. Create a flow in Cognigy with a Handover to Human Agent node.
  2. In the Handover provider field of the node, select the RingCentral Engage handover provider, then configure the following fields:
    • Additional Category Ids — sets additional CATEGORY_ID values to pass to the RingCentral Engage handover provider, beyond the Bot Category ID and Agent Category ID configured in the handover provider.
    • Notify agent when end user joins — notifies human agents when an end user reconnects to the chat. This parameter is activated by default. When it’s activated, the message User joined the conversation appears in the chat as soon as the end user returns to the chat tab by clicking the ← (back arrow) at the top bar in the browser, after having opened a new URL on the same tab as the chat.
    • Notify agent when end user leaves — notifies human agents when an end user disconnects from the chat. This parameter is activated by default. When it’s activated, the message User left the conversation is sent as soon as the end user closes the tab with the chat or switches to a new URL address within the current tab.
  3. Link the endpoint to this flow.
  4. When triggered, this node escalates the conversation to RingCentral Engage, assigning it the Agent category and sending the Cognigy User Profile to RingCentral Engage. See Send user profile.
After configuring the Handover Settings, test the setup: send a message to the Endpoint and make sure that a conversation appears in RingCentral Engage.

Additional configuration

Ensure human agents with API token ownership have reply permissions on all non-custom SDK sources.
During a Handover event, the Contact Profile is sent to RingCentral Engage to provide helpful information to human agents.
The Cognigy Contact Profile is sent to RingCentral Engage and matched up with the object keys existing on RingCentral Engage. The information that wasn’t matched is added to the context_data object.
The Get queue updates setting enables the injection of queue updates into the conversation flow as events. This capability allows you to react to queue updates within your conversation.In addition to enabling the Get queue updates option, you need to configure the Lookup node so that the handover type is selected as Queue. For more details, refer to the Handover Status section.The queue updates from RingCentral Engage are visible in the input.data.handover object. The object contains the following properties:
  • estimatedWaitTime — the approximate wait time for the user, measured in milliseconds.
  • position — the conversation’s position in the queue.

More information

Last modified on November 11, 2026