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

# Gong

> Learn how to connect Opal to Gong with a read-only integration that syncs users, workspaces, and permission profile members.

With the Gong integration, you can see who has access to Gong, and at what level:

* Sync Gong users (including deactivated users), and each workspace's permission profiles with their members
* Review Gong permission profile membership in access reviews
* Set the right resource owners for each workspace and permission profile

Opal connects to one Gong company through a Gong API key. To connect several Gong companies, add a Gong app in Opal for each one.

## Supported resources

| Resource | Read | Grant and revoke access |
| - | - | - |
| Gong workspaces | ✔️ | |
| Permission profiles (profile members) | ✔️ | |

> [!NOTE]
>
> **This is a read-only integration.** Opal can't grant or revoke Gong permission profiles. Gong's API has no endpoint that assigns a user to a permission profile or removes them from one. Its API can only read profiles and their members. In Gong, profiles are assigned in the Admin center or by Gong's team member provisioning, which applies a profile to each member of an identity provider group.
>
> To manage Gong access through Opal, map an Okta or Microsoft Entra ID group to a permission profile in Gong's team member provisioning, with **Update settings** set to **Automatic updates**. Then manage that group in Opal with the [Okta](https://docs.opal.dev/integrations/okta.md) or [Azure](https://docs.opal.dev/integrations/azure.md) integration. When a user gains or loses the group, Gong updates their permission profile.

### How Gong access maps to Opal

* **Workspaces**: each Gong workspace is a resource, with its permission profiles nested under it.
* **Permission profiles**: each profile is a resource, and its members are the users Gong lists for that profile. A user holds one permission profile in each workspace they belong to.
* **Users**: Opal syncs all Gong users returned by the API, including deactivated users. Deactivated users can still hold permission profiles in Gong, so they remain visible for reviews.

## Requirements

Before you begin, you must:

* Be an Opal Admin
* Be a Gong Technical Administrator, which is the only role that can create API keys
* Ask the Opal team to enable the Gong integration for your organization

## Configuration steps

### 1. Create a Gong API key

1. In Gong, go to **Admin center** > **Settings** > **Ecosystem** > **API**, and select **+ Get API key**.
2. Name the key, for example `Opal`. Leave the expiration empty, because Opal stops syncing when the key expires.
3. Leave **Trusted IPs** empty unless you've confirmed Opal's outbound IP addresses with the Opal team. Gong rejects calls from any other address.
4. Select **Get API key**, then copy the **Access key** and **Access key secret**. Gong shows the secret only once.
5. On the same page, copy your API base URL, for example `https://us-12345.api.gong.io`. You'll enter its first part, `us-12345`, in Opal.

A Gong API key can call every Gong API endpoint. Opal only reads users, workspaces, and permission profiles, and never reads calls, transcripts, or emails. It calls only these endpoints:

| Endpoint | Used to |
| - | - |
| `GET /v2/users` | List users |
| `GET /v2/workspaces` | List workspaces and check the connection |
| `GET /v2/all-permission-profiles` | List each workspace's permission profiles |
| `GET /v2/permission-profile` | Read one permission profile |
| `GET /v2/permission-profile/users` | List a permission profile's members |

### 2. Create the Gong app in Opal

In Opal, go to **Inventory** > **+App** and select **Gong**. Fill in the following fields:

| Field | Value |
| - | - |
| App name | A name for the Gong app in Opal, for example `Gong`. |
| App admin | The owner who administers the app in Opal. |
| Description | A short description that helps requesters understand what this app is. |
| Visibility | Who in your organization can see the app. |
| API host | The first part of your API base URL from step 1, for example `us-12345`. |
| Access key | The access key from step 1. |
| Access key secret | The access key secret from step 1. |

Opal checks the API key when you save the app.

### 3. Import workspaces and permission profiles

After you save the app, import the workspaces and permission profiles you want to review: on the app's **Assets** tab, select **Import assets**. Opal pulls access only for imported items, so profile members appear after the next sync.

## Troubleshooting

| Error | Fix |
| - | - |
| `config.subdomain ... must be one lowercase DNS label` | Enter only the first part of the API base URL, such as `us-12345`, not `https://us-12345.api.gong.io`. |
| `401` or access denied when you save the app or sync | Copy the access key and secret again, and check that the key hasn't expired or been deleted, and that **Trusted IPs** allows Opal. |
| Access is out of date after a change in Gong | Opal picks up Gong changes on the next sync. Sync the app to refresh it. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.