From 48c2cc58c11bc71d9f262a0777d87a43370aa8f5 Mon Sep 17 00:00:00 2001 From: Alan Johnson Date: Thu, 30 Jan 2025 14:50:06 -0500 Subject: [PATCH] Add gong-oauth --- docs-v2/integrations/all/gong-oauth.mdx | 60 +++++++++++++++++++ .../generated/gong-oauth/PreBuiltTooling.mdx | 41 +++++++++++++ .../generated/gong-oauth/PreBuiltUseCases.mdx | 15 +++++ 3 files changed, 116 insertions(+) create mode 100644 docs-v2/integrations/all/gong-oauth.mdx create mode 100644 docs-v2/snippets/generated/gong-oauth/PreBuiltTooling.mdx create mode 100644 docs-v2/snippets/generated/gong-oauth/PreBuiltUseCases.mdx diff --git a/docs-v2/integrations/all/gong-oauth.mdx b/docs-v2/integrations/all/gong-oauth.mdx new file mode 100644 index 00000000000..8601833b2ee --- /dev/null +++ b/docs-v2/integrations/all/gong-oauth.mdx @@ -0,0 +1,60 @@ +--- +title: Gong OAuth +sidebarTitle: Gong OAuth +provider: gong-oauth +--- + +import Overview from "/snippets/overview.mdx"; +import PreBuiltTooling from "/snippets/generated/gong-oauth/PreBuiltTooling.mdx"; +import PreBuiltUseCases from "/snippets/generated/gong-oauth/PreBuiltUseCases.mdx" + + + + + +## Access requirements +| Pre-Requisites | Status | Comment| +| - | - | - | +| Paid dev account | ❓ | | +| Paid test account | ❓ | | +| Partnership | ❓ | | +| App review | ❓ | | +| Security audit | ❓ | | + + +## Setup guide + +_No setup guide yet._ + +Need help getting started? Get help in the [community](https://nango.dev/slack). + +Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/gong-oauth.mdx) + + +## Useful links + +Gong offers both Basic auth (API key) and OAuth as authentication. Nango implements both. To register an OAuth app, you need to request a developer account. At first, the OAuth app will be private (only for test) and you need an additional approval to make it public. + +- [How to find API credentials (for end-users)](https://help.gong.io/hc/en-us/articles/360042449451-Receive-access-to-the-API) +- [Request a developer account to create an OAuth app](https://app.gong.io/welcome/developer/sign-up) +- [API Docs](https://app.gong.io/settings/api/documentation#overview) +- [Oauth-related docs](https://help.gong.io/hc/en-us/articles/13944551222157-Create-an-app-for-Gong) +- [API rate limiting](https://app.gong.io/settings/api/documentation#overview) +- [SCIM API Docs](https://help.gong.io/docs/provision-team-members-from-a-custom-source-scim) +- [Retrieve Access Key and Access Key Secret](https://help.gong.io/docs/receive-access-to-the-api) + +Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/gong-oauth.mdx) + +## API gotchas + +- End users can generate API keys [on the Gong API page](https://app.gong.io/company/api). They must have the "technical administrator" user role to do this. +- Gong uses BASIC auth for their API, but doesn't call them username and password: `Access Key` is the username in Nango and `Access Key Secret` is the password in Nango. +- [Gong rate-limits](https://app.gong.io/settings/api/documentation#overview) are per second and a total of 10k requests a day. +- Gong-oauth uses `api_base_url_for_customer`, which varies for each customer, as its `base_url` for proxy requests. This parameter is returned in the response of `generate-customer-token`. +- By default Gong limits your company's access to the service to 3 API calls per second, and 10,000 API calls per day. You may however change this rates by contacting [help](https://help.gong.io/). + +Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/gong-oauth.mdx) + + + Guide to connect to Gong API using Nango Connect. + diff --git a/docs-v2/snippets/generated/gong-oauth/PreBuiltTooling.mdx b/docs-v2/snippets/generated/gong-oauth/PreBuiltTooling.mdx new file mode 100644 index 00000000000..23bcfe5ac57 --- /dev/null +++ b/docs-v2/snippets/generated/gong-oauth/PreBuiltTooling.mdx @@ -0,0 +1,41 @@ +## Pre-built tooling + + +| Tools | Status | +| - | - | +| Pre-built authorization (OAuth) | ✅ | +| Credentials auto-refresh | ✅ | +| Auth parameters validation | ✅ | +| Pre-built authorization UI | ✅ | +| Custom authorization UI | ✅ | +| Expired credentials detection | ✅ | + + +| Tools | Status | +| - | - | +| Pre-built integrations | ✅ | +| API unification | ✅ | +| 2-way sync | ✅ | +| Webhooks from Nango on data modifications | ✅ | +| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) | +| Proxy requests | ✅ | + + +| Tools | Status | +| - | - | +| HTTP request logging | ✅ | +| End-to-type type safety | ✅ | +| Data runtime validation | ✅ | +| OpenTelemetry export | ✅ | +| Slack alerts on errors | ✅ | +| Integration status API | ✅ | + + +| Tools | Status | +| - | - | +| Create or customize use-cases | ✅ | +| Pre-configured pagination | 🚫 (time to contribute: <48h) | +| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) | +| Per-customer configurations | ✅ | + + \ No newline at end of file diff --git a/docs-v2/snippets/generated/gong-oauth/PreBuiltUseCases.mdx b/docs-v2/snippets/generated/gong-oauth/PreBuiltUseCases.mdx new file mode 100644 index 00000000000..cdb14ab5e82 --- /dev/null +++ b/docs-v2/snippets/generated/gong-oauth/PreBuiltUseCases.mdx @@ -0,0 +1,15 @@ + +## Pre-built integrations + + + + + +| Endpoint | Description | Readme | +| - | - | - | +| `GET /users` | Fetches the list of gong users | [🔗](https://github.com/NangoHQ/integration-templates/blob/main/integrations/gong-oauth/syncs/users.md) | + + + + +Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integrations/overview) independently.