Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Conga API Connections

The Conga API Connections tab allows you to configure and manage authentication for interacting with Conga Advantage Platform APIs. It supports two types of connections: API-to-API and UI-to-API. These connections enable secure access to Conga services based on the intended integration method.

To use Conga Advantage Platform APIs, you must create a connection within this tab to generate a Client ID and Client Secret. These credentials are required for authenticating requests and establishing trust between your external application and the Conga Advantage Platform.

API-to-API connections are typically used for back-end system integrations or automated processes, while UI-to-API connections are intended for user-interactive flows.

Note:

To configure API connections, you can also use the API Connections APIs instead of the user interface.

Configuring an API-to-API Connection

  • You are an administrator.
  • External integration is added that will use the Conga Advantage Platform APIs.
This task guides you through configuring an API-to-API connection in the Conga Advantage Platform. API-to-API connections are used for server-to-server communication, enabling external systems or services to authenticate and securely interact with the Conga platform without requiring user involvement. Creating this connection generates a Client ID and Client Secret, which are required to authorize API requests.
Note:

Conga recommends the Integration User flow instead of API-to-API connection. For more information on how to create an integration user and generate a Client ID and Secret, see the Adding a User.

  1. Log in to the Conga Advantage Platform as an administrator.
  2. Click the App Launcher () icon from the top-left corner, then go to Admin Console > Organization.
  3. Go to the Conga API Connections tab.
  4. Click Add API-to-API Connection.
  5. Enter values in the following fields:

    Field

    Description

    External Identifier

    Select the respective External Identifier for which you want to configure the connection. The external identifier list is populated based on the External Integration that you added. For more information, see Managing External Integrations.

    Client Name

    Enter the appropriate client name. It will help you identify the specific connection from the list view.

    Description

    Enter the appropriate description.

  6. Click Save & Generation Client Secret to generate the Client ID and Client Secret.
  7. Copy the Client ID and Client Secret.
    Note:

    Once copied, the Client Secret cannot be recovered. You must regenerate the client secret by clicking the External Identifier hyperlink on the list page > Save & Regenerate Client Secret button. After regenerating the Client Secret, ensure that you update it in all your connected API solutions. Please note that the regenerated Client Secret may take up to 10 minutes before it becomes usable across all connected API solutions.

The API-to-API connection is configured and activated. You can Deactivate or Reactivate any of the Conga API Connections by using the respective hyperlink under the Actions column, and Edit the configuration by clicking the External Identifier hyperlink on the list page.

Note: When you use an authentication token generated using the Conga API‑to‑API flow to utilize APIs, include the platform user ID in your API request header . Set the header key to user-id and the value to your platform user ID. The API uses your platform user ID to identify who is making the request and to apply the correct permissions.

Connecting the Advantage Platform UI to the Salesforce API

Follow this procedure to establish a UI-to-API connection from Advantage Platform to your Salesforce org, enabling instantaneous communication and data exchange.
  1. From Conga Start or from the App Launcher () icon, click through Admin Console > Organization > Conga API Connections > Add UI-To-API Connection.
  2. Enter values in the following fields.

    Field

    Required Action

    External Identifier

    Select the Salesforce org ID you will connect to. The external identifier list reflects the external integrations that have already been added.

    For more information, see Managing External Integrations.

    Client Name

    Enter the client’s name.

    Description

    Describe the connection; for example, “Salesforce CLM pipeline", or "Accounts receivable hub"

    Redirect URI

    Enter the UI callback endpoint where the UI sends identification and access tokens.

    Note: You can configure multiple redirect URIs in a UI-to-API connection by entering comma-separated values in the Redirect URI field.
    • For the production instance: https://prod-rls10.congacloud.com/static/clm/congacopilot/?q=param
    • For the preview instance: https://preview-rls09.congacloud.com/static/clm/congacopilot/?q=param
    • For the staging instance: https://rls-stg.congacloud.io/static/clm/congacopilot/?q=param

    Cors Origins

    Enter the domain name in the callback endpoint. This is the origin server’s base URL for cross-site requests.

    For example, https://business-agility-9613-dev-ed.scratch.my.salesforce.com

    Leave the other fields blank.
  3. Click Save & Generate Client ID.
    The client ID is generated in the bottom gray box.
  4. Click the Copy button next to the ID string. Save it securely for future use.
    CAUTION: You will not get a second chance to copy this string: once you leave this page, it cannot be recovered. If you lose the ID string, you must regenerate it and update it in all connected API applications.
  5. Click Save.
The UI-to-API connection is configured and activated, and now appears in the Conga API Connections tab.

You can edit the configuration by clicking the External Identifier hyperlink on the list page. You can use the hyperlinks in the Actions column to deactivate or reactivate the API connection.