- Both halves of the key. The access key is the connection’s API key and the secret is its
api_key_secretfield. In code you can passaccessKeyandaccessKeySecrettogong()instead. - API host. Requests go to
https://api.gong.io. If Gong shows your company its own base URL, such ashttps://us-12345.api.gong.io, pass it asbaseUrl. The plugin acceptsapi.gong.ioand<name>.api.gong.ioand rejects any other host. - OAuth is a token you bring.
authType: 'oauth_2'sends a bearer token as it is. The plugin does not run Gong’s OAuth flow and does not refresh the token, and a Gong token lasts one day. Pass theapi_base_url_for_customervalue from Gong’s token response asbaseUrl. - IDs are digit strings. Gong IDs are 64-bit numbers, too large for a JavaScript number. Pass them as strings, the way
workspaces.listreturns them. - Paging. A list returns
records.cursorwhile more pages exist. Send it back ascursorand keep every other input the same. - Rate limits. Gong allows 3 calls a second and 10,000 a day by default, and answers 429 with
Retry-After. The plugin waits that long and retries up to three times. - Erasing data cannot be undone.
dataPrivacy.purgeEmailAddressanddataPrivacy.purgePhoneNumberdelete the emails, calls, leads and contacts tied to that address or number. Gong takes several hours to finish. - Credits.
entities.askandentities.generateBriefuse Gong credits on every call. - Personal data stays out of the event log. Events record IDs, date ranges and list sizes. Names, email addresses, phone numbers, prospects, call parties and questions are not stored.
- Webhooks. The plugin does not receive webhooks.
- 66 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
- OAuth 2.0
No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.More: API Key
4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
List last week’s callsWhat’s next
API reference
Every
gong.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.