RingCentral Engage - Cognigy Documentation
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
As of Cognigy.AI 4.97.0, the Handover Providers section in the Endpoint settings is deprecated. From Cognigy.AI 2026.4 on, the Handover Settings section in the Endpoint settings is in read-only mode. You can’t use this section to configure new handover providers. You can still view configured handover provider settings, but you can’t change them. To configure handover providers, use the Handover Providers interface, which offers greater flexibility for managing your integration with contact centers. For a smooth migration, refer to the migration guide.
The RingCentral Engage Endpoint enables you to connect your AI Agent to the RingCentral Engage platform.
Prerequisites
- Access to RingCentral Engage.
Adminrole in RingCentral Engage.
Generic Endpoint Settings
- Endpoints Overview
- NLU Connectors
- Data Protection & Analytics
- Real-Time Translation Settings
- Transformer Functions
- Inject and Notify
Specific Endpoint Settings
RingCentral Engage Setup
| Parameter | Description |
|---|---|
| API URL | The URL determined by your application name and API version. The URL format is https://api.ringcentral.com/restapi/v1.0/accounts/{accountId} |
| Access Token | The token for API requests. |
| Verification Token | The token that adds an extra layer of security to verify the authenticity of API requests to your RingCentral API domain. |
| Secret | The secret key matching the RingCentral Engage webhook configuration, used for the handshake process. |
| Bot Category ID | The category ID used to identify the bot, obtained from the RingCentral Engage platform. |
| Agent Category ID | The category ID used to identify the agent, obtained from the RingCentral Engage platform. |
How to Set Up
Create a RingCentral Engage 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 RingCentral Engage Endpoint type.
- Specify a unique name.
- Select a Flow from the list. Save changes.
- Go to the Configuration Information section and copy the URL from the Endpoint URL field.
- In the RingCentral Engage Setup section, copy the Secret value for later use.
- Create a verification token and paste it into the Verification Token field. The token can be any string, but must be kept secret and secure. Copy the value for later use. This token will be used to verify the authenticity of API requests to your RingCentral API domain.
Create API Access Token
Log in to your RingCentral Engage account.
- Go to ADMIN > API Access Tokens. Click + to create a new token.
- Assign an Agent with permissions to read and reply to your source.
- Copy the value from the Access Token field for later use.
Create Categories
Go to ADMIN > Categories.
- Create a new parent category. For example,
Cognigy. Then, create two subcategories:BotandAgent. - Copy the category IDs from the URL for later use.
- Create a new parent category. For example,
Configure Sources
Go to ADMIN > Sources.
- Select your source and under MESSAGE SETTINGS, set the Default Category to the Bot category.
- Save the configuration.
Create a Webhook
Go to ADMIN > Webhooks.
- Click + to create a new webhook. Configure the following settings:
- API Access Token – use the token created earlier.
- Active – enable the webhook.
- URL – paste the Cognigy.AI Endpoint URL.
- Secret – paste the secret from Cognigy.AI Endpoint.
- Sources Filtering Strategy – select No sources except.
- Sources – select your source.
- Registered Events – enter
content.imported. - Verification Token – paste the verification token from Cognigy.AI Endpoint.
- Save the webhook.
- Click + to create a new webhook. Configure the following settings:
Complete the Endpoint Configuration
In the RingCentral Engage Setup section of your Endpoint, fill in the following fields:
- API URL – enter the URL in the following format:
https://api.ringcentral.com/restapi/v1.0/accounts/{accountId}. - Access Token – paste the Access Token copied earlier from RingCentral Engage.
- Bot Category ID – paste the Bot Category ID copied earlier from RingCentral Engage.
- Agent Category ID – paste the Agent Category ID copied earlier.
- Save changes. Test the connection by sending a message via RingCentral Engage chat.
- API URL – enter the URL in the following format:
More Information
- Cognigy Help Center: RingCentral Engage Deployment
- Cognigy Help Center: RingCentral Engage Send Structured Content
- Cognigy Help Center: RingCentral Engage Handover Integration
Last modified on June 15, 2026