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

# Basic Auth

> Connect Parable to Gong using an Access Key and Secret

export const platform_1 = "Gong"

export const limit_0 = "about 3 requests/second and 10,000 requests per day; Parable respects Retry-After"

export const platform_0 = "Gong"

export const role_0 = "Technical Administrator (to create API keys and manage scopes)"

export const tokenName_0 = "Access Key Secret"

<Tabs>
  <Tab title="Setup">
    <Card title="What You'll Need" icon="key">
      | Credential            | What it is                                                                       |
      | --------------------- | -------------------------------------------------------------------------------- |
      | **Access Key**        | Workspace API access key from Gong                                               |
      | **Access Key Secret** | Secret shown once when the key is created                                        |
      | **API Base URL**      | Gong API host (`https://api.gong.io` or your regional URL from Company Settings) |
    </Card>

    ## Overview

    Connect Parable to Gong for calls, CRM, meetings, and workspace analytics using HTTP Basic authentication with a workspace-scoped Access Key and Secret.

    <CardGroup cols={2}>
      <Card title="Conversations & CRM" icon="phone">
        Call recordings, transcripts, CRM associations, meetings
      </Card>

      <Card title="People & workspace" icon="users">
        Users, workspaces, scorecards, trackers, audit logs
      </Card>
    </CardGroup>

    ## Prerequisites

    <Info>
      **Setup access in {platform_0}.** These steps require **{role_0}**, or a colleague with equivalent permissions who can create credentials for you.

      If that is not you, ask your {platform_0} administrator.
    </Info>

    * Your Gong **API Base URL**. Most workspaces use `https://api.gong.io`. Regional endpoints (for example `https://us-12345.api.gong.io`) appear under **Company Settings → Ecosystem → API**.

    <Info>
      Gong API keys are workspace-scoped. They can expire; Gong notifies workspace admins before rotation.
    </Info>

    ## Setup Guide

    <Steps>
      <Step title="Open Gong API settings">
        1. Sign in to Gong as a Technical Administrator.
        2. Open **Company Settings → Ecosystem → API** (or go to <a href="https://app.gong.io/company/api" target="_blank" rel="noopener noreferrer">app.gong.io/company/api</a>).
      </Step>

      <Step title="Enable required API scopes">
        Each API key in Gong has scopes toggled individually. Enable only the scopes for the data categories you want Parable to collect.

        | Scope                                   | Purpose                                  |
        | --------------------------------------- | ---------------------------------------- |
        | `api:calls:read:basic`                  | Call recordings                          |
        | `api:calls:read:extensive`              | Call details & AI insights               |
        | `api:calls:read:transcript`             | Call transcripts                         |
        | `api:users:read`                        | Users & settings history                 |
        | `api:settings:scorecards:read`          | Scorecard definitions                    |
        | `api:stats:scorecards`                  | Scorecard responses                      |
        | `api:settings:trackers:read`            | Tracker definitions                      |
        | `api:workspaces:read`                   | Workspaces & library folders             |
        | `api:logs:read`                         | Audit logs                               |
        | `api:crm-calls:manual-association:read` | CRM call associations                    |
        | `api:stats:user-actions:detailed`       | Daily user activity                      |
        | `api:stats:interaction`                 | Interaction statistics                   |
        | `api:stats:user-actions`                | Activity aggregates                      |
        | `api:crm:get-objects`                   | CRM entities (Accounts, Contacts, Deals) |
        | `api:meetings:integration:status`       | Meetings                                 |
        | `api:permission-profile:read`           | Permission profiles                      |
        | `api:crm:integrations:read`             | CRM integrations                         |

        <Info>
          `api:permission-profile:read` may need to be enabled by Gong Support on some tiers.
        </Info>
      </Step>

      <Step title="Create API credentials">
        1. Click **Get API Key**.
        2. Copy the **Access Key** and **Access Key Secret**. The secret is shown once — store it in a password manager before closing the page.

        <Warning>
          **Copy your {tokenName_0} now!**

          This is the only time it will be displayed. Store it in a secure password manager before closing this page.
        </Warning>
      </Step>

      <Step title="Enter values in the form">
        1. **Access Key**, **Access Key Secret**, and **API Base URL**: Enter the values from Gong (use your regional base URL if applicable).
        2. Click **Save & test connection**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Reference">
    ## Scopes Quick Reference

    | Scope                                   | Purpose                                  |
    | --------------------------------------- | ---------------------------------------- |
    | `api:calls:read:basic`                  | Call recordings                          |
    | `api:calls:read:extensive`              | Call details & AI insights               |
    | `api:calls:read:transcript`             | Call transcripts                         |
    | `api:users:read`                        | Users & settings history                 |
    | `api:settings:scorecards:read`          | Scorecard definitions                    |
    | `api:stats:scorecards`                  | Scorecard responses                      |
    | `api:settings:trackers:read`            | Tracker definitions                      |
    | `api:workspaces:read`                   | Workspaces & library folders             |
    | `api:logs:read`                         | Audit logs                               |
    | `api:crm-calls:manual-association:read` | CRM call associations                    |
    | `api:stats:user-actions:detailed`       | Daily user activity                      |
    | `api:stats:interaction`                 | Interaction statistics                   |
    | `api:stats:user-actions`                | Activity aggregates                      |
    | `api:crm:get-objects`                   | CRM entities (Accounts, Contacts, Deals) |
    | `api:meetings:integration:status`       | Meetings                                 |
    | `api:permission-profile:read`           | Permission profiles                      |
    | `api:crm:integrations:read`             | CRM integrations                         |

    ## Verify Your Setup

    Use environment variables so secrets do not appear in shell history:

    <CodeGroup>
      ```bash Test with curl theme={null}
      read -rs -p "Access Key: " GONG_KEY && echo
      read -rs -p "Access Key Secret: " GONG_SECRET && echo
      read -p "API Base URL [https://api.gong.io]: " GONG_BASE_URL
      GONG_BASE_URL="${GONG_BASE_URL:-https://api.gong.io}"
      curl --silent --user "${GONG_KEY}:${GONG_SECRET}" \
        "${GONG_BASE_URL}/v2/workspaces"
      unset GONG_KEY GONG_SECRET GONG_BASE_URL
      ```
    </CodeGroup>

    <Check>
      **Success!** If you received a `200 OK` response with valid data, your credentials are configured correctly. You can now proceed to configure this connector in Parable.
    </Check>

    <Tip>
      A successful response includes `requestId`, `records`, and a `workspaces` array. Prefer `curl --netrc-file` over `curl -u "KEY:SECRET"` for one-liners so credentials are not written to shell history.
    </Tip>

    <Tip>
      **Rate Limits:** {platform_1} enforces rate limits of **{limit_0}**.

      Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
    </Tip>

    ## Troubleshooting

    | Error                                  | Meaning                  | Solution                                                      |
    | -------------------------------------- | ------------------------ | ------------------------------------------------------------- |
    | `401 Unauthorized`                     | Bad Access Key or Secret | Re-generate the key from the API settings page                |
    | `401` after a working period           | Key expired              | Generate a fresh key; Gong rotates keys periodically          |
    | `403 Forbidden` on a specific endpoint | Missing API scope        | Ask the Gong admin to enable the scope for that data category |
    | `429 Too Many Requests`                | Rate limit               | Parable backs off using `Retry-After`                         |
    | Empty data on `calls`                  | No calls in range        | Calls need `fromDateTime` in the last 90 days per request     |

    <Accordion title="Common Issues">
      ### Cannot find the API page

      The **Ecosystem → API** menu appears only for users with the Technical Administrator role.

      ### Permission Profiles returns 401 / 403

      Requires `api:permission-profile:read` on the key. Some tiers need Gong support to enable the scope.
    </Accordion>

    ## Additional Resources

    <CardGroup cols={2}>
      <Card title="Gong API docs" icon="book" href="https://app.gong.io/settings/api/documentation">
        Endpoint reference (requires login)
      </Card>

      <Card title="API access guide" icon="key" href="https://help.gong.io/docs/receive-access-to-the-api">
        Customer-facing setup guide
      </Card>
    </CardGroup>
  </Tab>
</Tabs>