> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# RingCentral Engage

<Frame>
  <img class="image-center" src="https://mintcdn.com/cognigy-15abf2ba/gMdd3UtLaZzJw9j6/_assets/ai/deploy/endpoint-reference/ring-central-engage.png?fit=max&auto=format&n=gMdd3UtLaZzJw9j6&q=85&s=64f61c8c4de420ceb52c8a149bf64a2d" alt="RingCentral Engage Endpoint logo" width="335" height="63" data-path="_assets/ai/deploy/endpoint-reference/ring-central-engage.png" />
</Frame>

<Warning>
  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](/ai/escalate/migration) interface, which offers greater flexibility for managing your integration with contact centers.
  For a smooth migration, refer to the [migration guide](/ai/escalate/migration).
</Warning>

The RingCentral Engage Endpoint enables you to connect your AI Agent to the [RingCentral Engage platform](https://www.ringcentral.com/engage/).

## Prerequisites

* Access to [RingCentral Engage](https://www.ringcentral.com/engage/).
* `Admin` role in RingCentral Engage.

## Generic Endpoint Settings

* [Endpoints Overview](/ai/agents/deploy/endpoints/overview)
* [NLU Connectors](/ai/platform-features/nlu/external/nlu-connectors/overview)
* [Data Protection & Analytics](/ai/agents/deploy/endpoints/data-protection-and-analytics)
* [Real-Time Translation Settings](/ai/agents/deploy/endpoints/real-time-translation-settings)
* [Transformer Functions](/ai/for-developers/transformers/overview)
* [Inject and Notify](/ai/agents/deploy/endpoints/inject-and-notify)

## Specific Endpoint Settings

<Accordion title="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.                                                     |
</Accordion>

## How to Set Up

<AccordionGroup>
  <Accordion title="1. Create a RingCentral Engage Endpoint">
    1. In the left-side menu of your Project, click **Deploy > Endpoints**.
    2. On the **Endpoints** page, click **+ New Endpoint**.
    3. In the **New Endpoint** section, do the following:
       1. Select the **RingCentral Engage** Endpoint type.
       2. Specify a unique name.
       3. Select a Flow from the list. Save changes.
    4. Go to the **Configuration Information** section and copy the URL from the **Endpoint URL** field.
    5. In the **RingCentral Engage Setup** section, copy the **Secret** value for later use.
    6. 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.
  </Accordion>

  <Accordion title="2. Create API Access Token">
    1. Log in to your [RingCentral Engage account](https://www.ringcentral.com/engage/).
    2. Go to **ADMIN > API Access Tokens**. Click **+** to create a new token.
    3. Assign an Agent with permissions to read and reply to your source.
    4. Copy the value from the **Access Token** field for later use.
  </Accordion>

  <Accordion title="3. Create Categories">
    1. Go to **ADMIN > Categories**.
    2. Create a new parent category. For example, `Cognigy`. Then, create two subcategories: `Bot` and `Agent`.
    3. Copy the category IDs from the URL for later use.
  </Accordion>

  <Accordion title="4. Configure Sources">
    1. Go to **ADMIN > Sources**.
    2. Select your source and under **MESSAGE SETTINGS**, set the **Default Category** to the **Bot** category.
    3. Save the configuration.
  </Accordion>

  <Accordion title="5. Create a Webhook">
    1. Go to **ADMIN > Webhooks**.
    2. 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.
    3. Save the webhook.
  </Accordion>

  <Accordion title="6. Complete the Endpoint Configuration">
    1. 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.
    2. Save changes. Test the connection by sending a message via RingCentral Engage chat.
  </Accordion>
</AccordionGroup>

## More Information

* [Cognigy Help Center: RingCentral Engage Deployment](https://support.cognigy.com/hc/en-us/articles/360016306779-RingCentral-Engage-Deploy-an-Endpoint)
* [Cognigy Help Center: RingCentral Engage Send Structured Content](https://support.cognigy.com/hc/en-us/articles/360016306859-RingCentral-Engage-Send-Structured-Content)
* [Cognigy Help Center: RingCentral Engage Handover Integration](https://support.cognigy.com/hc/en-us/articles/360016275260-RingCentral-Engage-Handover-Integration)
