Gong

Learn how to use Gong with Composio

Overview

SLUG: GONG

Description

Gong is a platform for video meetings, call recording, and team collaboration.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to api:calls:read:transcript,api:provisioning:read,api:workspaces:read,api:meetings:user:delete,api:crm:get-objects,api:data-privacy:delete,api:crm:schema,api:flows:write,api:crm:upload,api:meetings:integration:status,api:calls:read:extensive,api:meetings:user:update,api:integration-settings:write,api:settings:scorecards:read,api:stats:scorecards,api:stats:interaction,api:stats:user-actions,api:crm:integration:delete,api:calls:read:basic,api:calls:read:media-url,api:tasks:read,api:digital-interactions:write,api:crm:integrations:read,api:library:read,api:data-privacy:read,api:users:read,api:tasks:write,api:logs:read,api:calls:create,api:meetings:user:create,api:stats:user-actions:detailed,api:settings:trackers:read,api:crm:integration:register,api:provisioning:read-write,api:engagement-data:write,api:permission-profile:read,api:permission-profile:write,api:flows:read,api:crm-calls:manual-association:read,api:call-outcomes:read
bearer_token
string
full
stringRequired
full
stringRequired
username
stringRequired
password
stringRequired

Connecting to Gong

Create an auth config

Use the dashboard to create an auth config for the Gong toolkit. This allows you to connect multiple Gong accounts to Composio for agents to use.

1

Select App

Navigate to Gong.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Gong Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4gong_auth_config_id = "ac_YOUR_GONG_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Gong: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, gong_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using Basic Auth

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5gong_auth_config_id = "ac_YOUR_GONG_CONFIG_ID"
6user_id = "user@example.com"
7username = "your_gong_username"
8password = "your_gong_password"
9
10composio = Composio()
11
12# Create a new connected account for Gong using Basic Auth
13connection_request = composio.connected_accounts.initiate(
14 user_id=user_id,
15 auth_config_id=gong_auth_config_id,
16 config=auth_scheme.basic_auth(
17 username=username,
18 password=password
19 )
20)
21
22# Basic authentication is immediate - no redirect needed
23print(f"Successfully connected Gong for user {user_id}")
24
25# You can verify the connection using:
26# connected_account = composio.connected_accounts.get(user_id=user_id, app_id="GONG")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Gong toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GONG"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Retrieve call data by date range v2 calls

Description

List calls that took place during a specified date range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.

Action Parameters

cursor
string
fromDateTime
stringRequired
toDateTime
stringRequired
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add call media v2 calls id media

Description

Adds a call media, recorded by a telephony system (pbx) or other media recording facility. gong accepts call recordings in various audio and video file formats, including wav, mp3, mp4, mkv and flac. if uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel correspondsto the company team member (rep) in the parties/mediachannelid parameter of the add new call operation. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:create'.

Action Parameters

id
stringRequired
mediaFile
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add new call v2 calls

Description

When using this endpoint, either provide a downloadmediaurl or use the returned callid in a follow-up request to /v2/calls/{id}/media to upload the media file. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:create'.

Action Parameters

actualStart
stringRequired
callProviderCode
string
clientUniqueId
stringRequired
context
array
customData
string
direction
stringRequired
disposition
string
downloadMediaUrl
string
duration
integer
languageCode
string
meetingUrl
string
parties
arrayRequired
primaryUser
stringRequired
purpose
string
scheduledEnd
string
scheduledStart
string
speakersTimeline__precise
boolean
speakersTimeline__speechSegments
array
title
string
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Aggregate activity by period via api

Description

Lists the aggregated activity of multiple users within the gong system for each time period within the defined date range. this endpoint returns multiple records, one for each user. for each user there are items for every time period in the date range, including statistics about the user's activity. records are returned only for users with activity in the range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.

Action Parameters

aggregationPeriod
stringRequired
cursor
string
filter__createdFromDateTime
string
filter__createdToDateTime
string
filter__fromDate
string
filter__toDate
string
filter__userIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Aggregate user activity statistics

Description

Lists the activity of multiple users within the gong system during a defined period. given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. each record includes statistics about the user's activity. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.

Action Parameters

cursor
string
filter__createdFromDateTime
string
filter__createdToDateTime
string
filter__fromDate
string
filter__toDate
string
filter__userIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Assign prospects to flow

Description

Use this endpoint to assign a number of prospects to a flow. prospects can be contacts or leads in your crm. generate a list of comma separated crm ids of the prospects you want to add to a flow. the flowinstanceowneremail parameter is the email address of the gong user who set up the flow instance and owns the flow to-dos. you can assign up to 200 prospects to a flow in a single request. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:flows:write'.

Action Parameters

crmProspectsIds
arrayRequired
flowId
stringRequired
flowInstanceOwnerEmail
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create activity scorecards report

Description

Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.

Action Parameters

cursor
string
filter__callFromDate
string
filter__callToDate
string
filter__reviewFromDate
string
filter__reviewMethod
string
filter__reviewToDate
string
filter__reviewedUserIds
array
filter__scorecardIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a new gong meeting v2 meetings

Description

When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.

Action Parameters

endTime
stringRequired
externalId
string
invitees
arrayRequired
organizerEmail
stringRequired
startTime
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create permission profile v2 permission profile

Description

Create a permission profile in a given workspace.

Action Parameters

account
boolean
activity
boolean
callsAccess__permissionLevel
string
callsAccess__teamLeadIds
array
callsAndSearch
boolean
coaching
boolean
coachingAccess__permissionLevel
string
coachingAccess__teamLeadIds
array
createEditAndDeleteDealsBoards
boolean
crmDataImport
boolean
crmDataInlineEditing
boolean
deals
boolean
dealsAccess__permissionLevel
string
dealsAccess__teamLeadIds
array
dealsInlineEditing
boolean
deleteCalls
boolean
deleteEmails
boolean
description
string
downloadCallMedia
boolean
emailsAccess__permissionLevel
string
emailsAccess__teamLeadIds
array
engageCreateAndManageRulesets
boolean
engageManageCompanySequences
boolean
engageManageCompanyTemplates
boolean
engageSnoozeFlowToDosForOthers
boolean
exportCallsAndCoachingDataToCSV
boolean
forecast
boolean
forecastManage
boolean
forecastPermissions__forecastAccess__permissionLevel
string
forecastPermissions__forecastAccess__teamLeadIds
array
forecastPermissions__forecastEditSubmissions__permissionLevel
string
forecastPermissions__forecastEditSubmissions__teamLeadIds
array
forecastPermissions__forecastEditTargets__permissionLevel
string
forecastPermissions__forecastEditTargets__teamLeadIds
array
id
string
initiatives
boolean
insightsAccess__permissionLevel
string
insightsAccess__teamLeadIds
array
library
boolean
libraryFolderAccess__libraryFolderIds
array
libraryFolderAccess__manageFolderCalls
boolean
libraryFolderAccess__managePublicFolder
boolean
libraryFolderAccess__manageStreams
boolean
libraryFolderAccess__permissionLevel
string
libraryFolderAccess__shareFoldersAndStreams
boolean
listenInCalls
boolean
manageGeneralBusinessSettings
boolean
manageRevenueAnalytics
boolean
manageScorecards
boolean
manuallyScheduleAndUploadCalls
boolean
market
boolean
name
string
overrideScore
boolean
privateCalls
boolean
scoreCalls
boolean
shareCallsWithCustomers
boolean
teamStats
boolean
trimCalls
boolean
usage
boolean
usageAccess__permissionLevel
string
usageAccess__teamLeadIds
array
viewEngageAnalyticsActivity
boolean
viewEngageAnalyticsFlows
boolean
viewEngageAnalyticsPerformance
boolean
viewRevenueAnalytics
boolean
workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Data privacy for phone number

Description

Shows the elements in the gong system that reference the given phone number. given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.

Action Parameters

phoneNumber
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a generic crm integration v2 crm integrations

Description

Deletes an existing crm integration from the gong platform. this endpoint should be used when you want to disconnect or remove a previously established integration between gong and a crm system, such as hubspot. it's particularly useful when you need to change crm providers, stop syncing data between gong and a specific crm, or troubleshoot integration issues by removing and re-adding the connection. the deletion is likely permanent, so use this endpoint with caution. it's important to note that this operation may affect data synchronization and potentially impact existing analytics or reports that rely on the integrated crm data.

Action Parameters

clientRequestId
stringRequired
integrationId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a gong meeting v2 meetings

Description

When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'.

Action Parameters

meetingId
integerRequired
organizerEmail
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete users from call access list

Description

Remove individual user access from calls. the request can only remove access previously given by the /v2/calls/users-access api. if a given user does not have access to the call, they will be unaffected. if a given user does have access to the call, but not through the pubic api (for example if the call was shared with the user), the user's access will remain unchanged. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.

Action Parameters

callAccessList
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Erase data for email address

Description

Given an email address, this endpoint deletes from the gong system any calls or email messages that reference this address. email messages sent to or from the address are deleted. calls where the email address appears (as a lead, contact, attendee or speaker) are deleted. leads or contacts with the email address are deleted. the deletion is not immediate, and may take several hours to complete. this endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. if the deletion fails please contact support at help@gong.io delete the data from your crm and email system before performing this operation so that private data is not re-imported into gong. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.

Action Parameters

emailAddress
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Erase data for phone number

Description

Given a phone number, this endpoint deletes from the gong system any leads or contacts with a matching phone number or mobile phone number. email messages sent to or from these leads/contacts are deleted. calls where the leads/contacts appear are deleted. the deletion is not immediate, and may take several hours to complete. this endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. if the deletion fails please contact support at help@gong.io delete the data from your crm and email system before performing this operation so that private data is not re-imported into gong. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.

Action Parameters

phoneNumber
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch all permission profiles

Description

Returns a list of all permission profiles. the listing is in the alphabetical order of the profile names.

Action Parameters

workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Crm Integration Details

Description

<style>.public-api-info { background: rgb(222, 235, 255);}.public-api-tip { background: rgb(227, 252, 239);}.public-api-parameter { background: rgba(9,30,66,0.08);}.public-api-note { background: rgb(234, 230, 255);}.public-api-important { background: rgb(255, 250, 230);}.public-api-critical { background: rgb(255, 235, 230);}table, th, td { border: 1px solid gray; border-collapse: collapse;}th, td { padding: 5px;}th { text-align: left;}img { border: 2px solid #d3d5d9;}</style><p>returns the crm integration you set up using the <code>put /v2/crm/integrations</code> endpoint. you can only have one integration at a time. </p><p>when accessed using a bearer token, this endpoint requires the 'api:crm:integrations:read' scope.</p>

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get crm objects v2 crm entities

Description

Retrieves crm entities from the gong platform. this endpoint allows users to fetch various crm objects such as accounts, deals, and contacts that have been integrated with gong's revenue intelligence system. it provides a way to access and utilize crm data within the context of gong's conversation analysis and insights. use this endpoint when you need to synchronize crm data with gong or when you want to retrieve the latest crm entity information for analysis or reporting purposes. the endpoint does not modify any data and is intended for read-only operations. note that the specific fields and structure of the returned entities may vary based on the crm system integrated with gong.

Action Parameters

integrationId
integerRequired
objectType
stringRequired
objectsCrmIds
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get permission profile

Description

Returns a permission profile.

Action Parameters

profileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get request status v2 crm request status

Description

The getcrmrequeststatus endpoint retrieves the current status of crm integration requests in the gong platform. it allows users to check the progress and outcome of operations related to crm data uploads, synchronization, or other crm-related processes. this endpoint is particularly useful for monitoring the health and progress of crm integrations, troubleshooting issues, and ensuring data consistency between gong and connected crm systems. it should be used when you need to verify if a crm integration request has been completed, is still in progress, or has encountered any errors. the endpoint does not modify any data and is intended for status checking only. note that the specific details returned may vary depending on the type and complexity of the crm integration request being queried.

Action Parameters

clientRequestId
stringRequired
integrationId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all coaching metrics v2 coaching

Description

List all of the coaching metrics of a manager. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:coaching:read'.

Action Parameters

from
stringRequired
manager__id
integerRequired
to
stringRequired
workspace__id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all company workspaces v2 workspaces

Description

Returns a list of all workspaces including their details. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:workspaces:read'.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List all users v2 users

Description

List all of the company's users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Action Parameters

cursor
string
includeAvatars
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List flows for crm prospects

Description

Get the gong engage flows assigned to the given prospects. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:flows:read'.

Action Parameters

crmProspectsIds
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Folder Calls

Description

Given a folder id, this endpoint retrieves a list of calls in it. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:library:read'.

Action Parameters

folderId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List gong engage flows v2 flows

Description

Engage flows have the following visibility types: * company: visible to everyone in the company, can only be edited by users with edit permissions. * personal: reps can set up their own flows which are only available to them. * shared: reps can share a flow with other reps. those reps can then add leads to the flow. this endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowemailowner parameter. when accessed through a bearer token authorization method, use the 'api:flows:read' scope.

Action Parameters

cursor
string
flowOwnerEmail
stringRequired
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List schema fields v2 crm entity schema

Description

Retrieves the comprehensive schema of crm entities in the gong platform. this endpoint provides detailed metadata about the structure, attributes, and relationships of entities within the customer relationship management (crm) system. it is particularly useful for developers integrating with gong's api who need to understand the data model of the crm entities. the endpoint returns a complete view of all crm entity schemas, which can be used for data mapping, validation, or building dynamic forms. note that this endpoint does not accept any parameters, meaning it returns the full schema without filtering options. while powerful, be mindful of potential performance implications when dealing with large, complex crm structures.

Action Parameters

integrationId
integerRequired
objectType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List users by filter v2 users extensive

Description

List multiple users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Action Parameters

cursor
string
filter__createdFromDateTime
string
filter__createdToDateTime
string
filter__includeAvatars
boolean
filter__userIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Manage user call access

Description

Returns a list of users who have received individual access to calls through the api. this endpoint doesn't cover user that have access for other reasons (such as sharing recipients, or access through permission profiles). when accessed through a bearer token authorization method, this endpoint requires the scope 'api:call-user-access:read'.

Action Parameters

filter__callIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Post a digital interaction v2 digital interaction

Description

When accessed through a bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'.

Action Parameters

content__contentAdditionalInfoUrl
string
content__contentCustomFields
array
content__contentId
string
content__contentLabel
array
content__contentTitle
string
content__contentUrl
string
content__numericContentDetails__numericType
string
content__numericContentDetails__rangeFrom
integer
content__numericContentDetails__rangeTo
integer
content__numericContentDetails__value
integer
content__searchObjectDetails__domain
string
content__searchObjectDetails__name
string
content__searchObjectDetails__objectId
string
content__searchObjectDetails__objectType
string
content__searchObjectDetails__url
string
content__stepContentDetails__availableSteps
array
content__stepContentDetails__value
string
customFields
array
device
string
eventId
stringRequired
eventType
stringRequired
person__company__companyBusinessContexts
array
person__company__companyId
string
person__company__domain
string
person__company__name
string
person__email
string
person__location__city
string
person__location__country
string
person__location__region
string
person__location__state
string
person__name
string
person__personBusinessContext__objectId
string
person__personBusinessContext__objectType
string
person__personBusinessContext__systemName
string
person__personCustomFields
array
person__personId
string
person__phoneNumber
string
sessionId
string
sourceSystemName
string
timestamp
stringRequired
trackingId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Post day by day activity stats

Description

Retrieve the daily activity of multiple users within the gong system for a range of dates. this endpoint returns records including statistics about each user's activity, on the daily level. records are returned only for users with activity in the range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions:detailed'.

Action Parameters

cursor
string
filter__createdFromDateTime
string
filter__createdToDateTime
string
filter__fromDate
string
filter__toDate
string
filter__userIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Post interaction filter stats

Description

Returns interaction stats for users based on calls that have whisper turned on. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.

Action Parameters

cursor
string
filter__createdFromDateTime
string
filter__createdToDateTime
string
filter__fromDate
string
filter__toDate
string
filter__userIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Post meeting integration status

Description

When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'.

Action Parameters

emails
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Register Crm Integration

Description

Updates an existing crm integration in the gong platform. this endpoint allows you to modify the details of a previously set up integration between gong and your customer relationship management (crm) system. it's primarily used for changing the integration's name or reassigning the ownership to a different team member. this operation is crucial for maintaining accurate and up-to-date integration configurations, especially when there are changes in your organization's structure or integration strategies. note that this endpoint only updates the integration metadata and does not affect the actual data synchronization between gong and your crm.

Action Parameters

name
stringRequired
ownerEmail
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Report content viewed event

Description

Push engagement events into gong and display them as events in gong’s activity timeline, when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect) when accessed through a bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

Action Parameters

actionName
string
agentPlatform
string
contentId
stringRequired
contentProperties
array
contentTitle
stringRequired
contentUrl
stringRequired
crmContext
array
eventId
string
eventProperties
array
eventTimestamp
stringRequired
mobileAppId
string
moreInfoUrl
string
nonCompanyParticipants
array
reportingSystem
stringRequired
shareId
string
sharer__email
string
sharer__id
string
sharer__name
string
sharingMessageBody
string
sharingMessageSubject
string
trackingId
string
userAgent
string
viewActionTitle
string
viewInfoUrl
string
viewer__context
array
viewer__email
string
viewer__name
string
viewer__title
string
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Report Custom Engagement Event

Description

Push engagement events into gong and display them as events in gong’s activity timeline, when a content is engaged by an external participant (for example, a contract was “signed” by the prospect) when accessed through a bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

Action Parameters

actionName
string
actor__context
array
actor__email
string
actor__name
string
actor__title
string
agentPlatform
string
contentId
string
contentProperties
array
contentTitle
string
contentUrl
string
crmContext
array
eventId
string
eventInfoUrl
string
eventProperties
array
eventTimestamp
stringRequired
mobileAppId
string
moreInfoUrl
string
nonCompanyParticipants
array
reportingSystem
stringRequired
shareId
string
sharer__email
string
sharer__id
string
sharer__name
string
sharingMessageBody
string
sharingMessageSubject
string
trackingId
string
userAgent
string
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve data for a specific call v2 calls id

Description

Retrieve data for a specific call. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve data privacy info for email address

Description

Shows the elements in the gong system that reference the given email address. given an emails address, this endpoint returns details of all calls and email messages that reference this address, and any leads or contacts with this email address. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.

Action Parameters

emailAddress
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve filtered call details

Description

Lists detailed call data for calls that took place during a specified date range, have specified call ids or hosted by specified users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. moreover, clients requesting media download urls by the contentselector.exposedfields.media field should also have the scope 'api:calls:read:media-url'.

Action Parameters

contentSelector__context
string
contentSelector__contextTiming
array
contentSelector__exposedFields__collaboration__publicComments
boolean
contentSelector__exposedFields__content__brief
boolean
contentSelector__exposedFields__content__callOutcome
boolean
contentSelector__exposedFields__content__highlights
boolean
contentSelector__exposedFields__content__keyPoints
boolean
contentSelector__exposedFields__content__outline
boolean
contentSelector__exposedFields__content__pointsOfInterest
boolean
contentSelector__exposedFields__content__structure
boolean
contentSelector__exposedFields__content__topics
boolean
contentSelector__exposedFields__content__trackerOccurrences
boolean
contentSelector__exposedFields__content__trackers
boolean
contentSelector__exposedFields__interaction__personInteractionStats
boolean
contentSelector__exposedFields__interaction__questions
boolean
contentSelector__exposedFields__interaction__speakers
boolean
contentSelector__exposedFields__interaction__video
boolean
contentSelector__exposedFields__media
boolean
contentSelector__exposedFields__parties
boolean
cursor
string
filter__callIds
array
filter__fromDateTime
string
filter__primaryUserIds
array
filter__toDateTime
string
filter__workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve library folders v2 library folders

Description

Use this endpoint to retrieve a list of public library folders. we do not allow retrieval of either private or archived folders. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:library:read'.

Action Parameters

workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve logs data by type and time range v2 logs

Description

List log entries that took place during a specified time range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:logs:read'.

Action Parameters

cursor
string
fromDateTime
stringRequired
logType
stringRequired
toDateTime
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve manual crm call associations

Description

Returns a list of all calls that were manually associated or re-associated with crm account and deal/opportunity since a given time. actions will be listed in the ascending order of their timing. notice if a call was associated and later re-associated the api will return both events. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:crm-calls:manual-association:read'.

Action Parameters

cursor
string
fromDateTime
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve scorecards details v2 settings scorecards

Description

Retrieve all the scorecards within the gong system. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve tracker details v2 settings trackers

Description

Retrieves details of all keyword trackers in the system or in a given workspace. when accessed through a bearer token authorization method, this endpoint requires the 'api:settings:trackers:read' scope.

Action Parameters

workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve transcripts of calls v2 calls transcript

Description

Returns transcripts for calls that took place during the specified date period. if call ids are specified, only transcripts for calls with those ids that took place during the time period are returned. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:transcript'.

Action Parameters

cursor
string
filter__callIds
array
filter__fromDateTime
string
filter__toDateTime
string
filter__workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve users from permission profile

Description

Returns a list of all users whose access is controlled by the given permission profile. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Action Parameters

profileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve User Settings History

Description

Retrieve a specific user's settings history. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve user v2 users id

Description

Retrieve a specific user. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set User Call Access

Description

Give individual users access to calls. if a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.

Action Parameters

callAccessList
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a gong meeting v2 meetings meetingid

Description

When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.

Action Parameters

endTime
stringRequired
externalId
string
invitees
arrayRequired
meetingId
integerRequired
organizerEmail
stringRequired
startTime
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update permission profile v2 permission profile

Description

Update a permission profile.

Action Parameters

account
boolean
activity
boolean
callsAccess__permissionLevel
string
callsAccess__teamLeadIds
array
callsAndSearch
boolean
coaching
boolean
coachingAccess__permissionLevel
string
coachingAccess__teamLeadIds
array
createEditAndDeleteDealsBoards
boolean
crmDataImport
boolean
crmDataInlineEditing
boolean
deals
boolean
dealsAccess__permissionLevel
string
dealsAccess__teamLeadIds
array
dealsInlineEditing
boolean
deleteCalls
boolean
deleteEmails
boolean
description
string
downloadCallMedia
boolean
emailsAccess__permissionLevel
string
emailsAccess__teamLeadIds
array
engageCreateAndManageRulesets
boolean
engageManageCompanySequences
boolean
engageManageCompanyTemplates
boolean
engageSnoozeFlowToDosForOthers
boolean
exportCallsAndCoachingDataToCSV
boolean
forecast
boolean
forecastManage
boolean
forecastPermissions__forecastAccess__permissionLevel
string
forecastPermissions__forecastAccess__teamLeadIds
array
forecastPermissions__forecastEditSubmissions__permissionLevel
string
forecastPermissions__forecastEditSubmissions__teamLeadIds
array
forecastPermissions__forecastEditTargets__permissionLevel
string
forecastPermissions__forecastEditTargets__teamLeadIds
array
id
string
initiatives
boolean
insightsAccess__permissionLevel
string
insightsAccess__teamLeadIds
array
library
boolean
libraryFolderAccess__libraryFolderIds
array
libraryFolderAccess__manageFolderCalls
boolean
libraryFolderAccess__managePublicFolder
boolean
libraryFolderAccess__manageStreams
boolean
libraryFolderAccess__permissionLevel
string
libraryFolderAccess__shareFoldersAndStreams
boolean
listenInCalls
boolean
manageGeneralBusinessSettings
boolean
manageRevenueAnalytics
boolean
manageScorecards
boolean
manuallyScheduleAndUploadCalls
boolean
market
boolean
name
string
overrideScore
boolean
privateCalls
boolean
profileId
stringRequired
scoreCalls
boolean
shareCallsWithCustomers
boolean
teamStats
boolean
trimCalls
boolean
usage
boolean
usageAccess__permissionLevel
string
usageAccess__teamLeadIds
array
viewEngageAnalyticsActivity
boolean
viewEngageAnalyticsFlows
boolean
viewEngageAnalyticsPerformance
boolean
viewRevenueAnalytics
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update shared content event

Description

Push engagement events into gong and display them as events in gong’s activity timeline, when a gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects) when accessed through a bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

Action Parameters

actionName
string
agentPlatform
string
contentId
stringRequired
contentProperties
array
contentTitle
stringRequired
contentUrl
stringRequired
crmContext
array
eventId
string
eventProperties
array
eventTimestamp
stringRequired
mobileAppId
string
moreInfoUrl
string
nonCompanyParticipants
array
recipients
array
reportingSystem
stringRequired
shareId
string
shareInfoUrl
string
sharer__email
string
sharer__id
string
sharer__name
string
sharingMessageBody
string
sharingMessageSubject
string
trackingId
string
userAgent
string
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload crm objects v2 crm entities

Description

Uploads crm data files to the gong platform for integration and analysis. this endpoint allows users to send large crm data files (up to 200mb) using a multipart/form-data request. it should be used when integrating crm systems with gong's revenue intelligence platform to provide up-to-date customer interaction data. the endpoint is specifically designed for file uploads and does not support other operations like querying or modifying existing data. ensure that the uploaded file contains properly structured crm data compatible with gong's system for successful integration and subsequent analysis.

Action Parameters

dataFile
object

Action Response

data
objectRequired
error
string
successful
booleanRequired