-
Notifications
You must be signed in to change notification settings - Fork 6
[ENG-3777] add docs on gong subscribe #592
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| title: Gong | ||
| --- | ||
|
|
||
| ## Checklist before you start | ||
|
|
||
| Confirm the following: | ||
|
|
||
| - You are a Gong **Technical Administrator** (the role required to create automation rules and configure outbound webhooks). | ||
| - Your developer has provided you with a **webhook URL** in this format: | ||
|
|
||
| ``` | ||
| https://subscribe-webhook.withampersand.com/v1/projects/PROJECT_ID/integrations/INTEGRATION_ID/installations/INSTALLATION_ID | ||
| ``` | ||
|
|
||
| ## Set up webhooks for real-time updates (Subscribe Actions) | ||
|
|
||
| To send `call.created` events to your developer's application, you'll create an **automation rule** in Gong that fires a webhook each time a call is processed. | ||
|
|
||
| 1. Sign in to Gong and open **Admin Settings** in the left sidebar. | ||
| <img src="/images/customer-guides/gong/admin-settings.png" /> | ||
| 2. In the left sidebar, navigate to **Automation rules**. | ||
| <img src="/images/customer-guides/gong/automation-rules.png" /> | ||
| 3. Click **Add rule**. | ||
| <img src="/images/customer-guides/gong/add-rule.png" /> | ||
| 4. (Optional) Add any filters you'd like to apply — for example, restrict the rule to specific participants. Leave the filters empty to send every new call. | ||
| <img src="/images/customer-guides/gong/filters.png" /> | ||
| 5. Paste the webhook URL your developer gave you into the **Enter URL** field. | ||
| <img src="/images/customer-guides/gong/webhook-url.png" /> | ||
| 6. Give the rule a descriptive name and toggle **"Rule Status"** to **Enabled**. | ||
| <img src="/images/customer-guides/gong/rule-status.png" /> | ||
| 7. (Optional) Send a test webhook and click Save. | ||
| <img src="/images/customer-guides/gong/test.png" /> | ||
|
|
||
| ## When to expect the webhook to fire | ||
|
|
||
| Gong fires the `call.created` webhook after a call has finished processing and appears in your Gong call library, which can take **several hours** after the call ends. You will not see events arrive immediately after a call wraps up — this is expected. | ||
|
|
||
| The screenshot below shows where a processed call shows up. Once a call reaches this state, the webhook has been (or will shortly be) sent. | ||
|
|
||
| <img src="/images/customer-guides/gong/processed-call.png" /> | ||
|
|
||
| ## For official setup details, see: | ||
|
|
||
| - [Gong Automation Rules overview](https://help.gong.io/docs/introduction-to-automation-rules) | ||
| - [Send a webhook from an automation rule](https://help.gong.io/docs/create-a-webhook-rule) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,19 +13,25 @@ updatedAt: "Fri Jul 19 2024 21:54:48 GMT+0000 (Coordinated Universal Time)" | |
| This connector supports: | ||
| - [Proxy Actions](/proxy-actions), using the base URL `https://api.gong.io`. | ||
| - [Read Actions](/read-actions) | ||
| - [Subscribe Actions](/subscribe-actions). Please note that [special set up](#set-up-subscribe-actions) is needed for Gong. | ||
|
|
||
| ### Supported Objects | ||
|
|
||
| The Gong connector supports **reading** from the following objects: | ||
| - Users (full read only) | ||
| - Workspaces (full read only) | ||
| - Flows (full read only) | ||
| - Calls and Transcripts (incremental read in private preview, contact [email protected]). | ||
| | Object | Read | Write | Subscribe | | ||
| | ----------- | ------------------------------------ | ----- | ------------------------ | | ||
| | Users | ✓ (full read only) | | | | ||
| | Workspaces | ✓ (full read only) | | | | ||
| | Flows | ✓ (full read only) | | | | ||
| | Calls | ✓ (incremental in private preview¹) | ✓ | ✓ (`call.created` only) | | ||
| | Transcripts | ✓ (incremental in private preview¹) | | | | ||
|
|
||
| The Gong connector supports **writing** to the following objects: | ||
| - Calls | ||
| ¹ Contact [email protected] to enable incremental read for Calls and Transcripts. | ||
|
|
||
| > **Note:** Due to Gong's processing time. `Calls` may not be available through Read Actions until up to an hour after a call ends, and `Transcripts` may not be available until up to 24 hours after a call ends. | ||
| <Note> | ||
| **Gong processing latency.** Gong takes time to process recordings before they become available, which delays both Read Actions and Subscribe webhooks: | ||
| - **Calls** are available through through Read and Subscribe Actions after they have finished processing in Gong, which may take up to **1 hour** after a call ends. | ||
| - **Transcripts** may not be available for up to **24 hours** after a call ends. | ||
| </Note> | ||
|
|
||
| ### Example Integration | ||
|
|
||
|
|
@@ -71,3 +77,35 @@ Learn more about the Gong Partnership process [here](https://help.gong.io/docs/h | |
|
|
||
|
|
||
| 8. Click **Save Changes**. | ||
|
|
||
| ## Set up Subscribe Actions | ||
|
|
||
| 1. **Define the subscribe action** in your `amp.yaml` and deploy it with the [amp CLI](/cli/overview). Gong only supports the `call.created` event, so the `calls` object should subscribe to `createEvent` only. | ||
|
|
||
| ```yaml | ||
| specVersion: 1.0.0 | ||
| integrations: | ||
| - name: subscribeToGong | ||
| provider: gong | ||
| subscribe: | ||
| objects: | ||
| - objectName: calls | ||
| destination: gongWebhook | ||
| inheritFieldsAndMapping: true | ||
| createEvent: | ||
| enabled: always | ||
| read: | ||
| objects: | ||
| - objectName: calls | ||
| destination: gongWebhook | ||
| requiredFields: | ||
| ... | ||
| ``` | ||
|
|
||
| 2. **Construct a webhook URL for your customer** in this format: | ||
|
|
||
| ``` | ||
| https://subscribe-webhook.withampersand.com/v1/projects/PROJECT_ID/integrations/INTEGRATION_ID/installations/INSTALLATION_ID | ||
| ``` | ||
|
|
||
| 3. **Share the [Gong customer guide](/customer-guides/gong)** with your customer along with the webhook URL from Step 2. Your customer will create an automation rule in Gong that fires a webhook when a new call is created. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.