Team
Shared credential for production and unattended runs.
Connect Gong with Hookshot™ and your stack
Gong is a platform for video meetings, call recording, and team collaboration.
Tools and triggers
What Agents can do in Gong
Available tools and events after Gong is connected.
-
Add Call Media
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…
-
Add New Call V2 Calls
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…
-
Aggregate Activity by Period via Api
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…
-
Aggregate User Activity Statistics
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…
-
Assign Prospects to Flow
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…
-
Create a New Gong Meeting V2 Meetings
When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.
-
Create Permission Profile V2 Permission Profile
Create a permission profile in a given workspace.
-
Data Privacy for Phone Number
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…
-
Delete a Generic CRM Integration
Deletes an existing generic CRM integration from the Gong platform. This endpoint asynchronously removes a CRM integration and all its associated CRM objects (Accounts, Contacts, Deals, Leads, and Users). Use this when…
-
Delete Meeting
Deletes a Gong meeting created via the Meetings API (Beta). Use this to remove a scheduled meeting by providing its unique meeting ID and the organizer's email address. Note: This endpoint is for meetings created…
-
Delete Users From Call Access List
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…
-
Erase Data for Email Address
Erase all data associated with an email address from Gong (GDPR compliance). This endpoint permanently deletes from the Gong system: - All calls where the email address appears (as lead, contact, attendee, or speaker)…
-
Erase Data for Phone Number
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…
-
Fetch All Permission Profiles
Returns a list of all permission profiles. The listing is in the alphabetical order of the profile names.
-
Get Call by ID
Tool to fetch specific call metadata by call ID. Use when you need to retrieve detailed information about a specific call using Gong's unique identifier.
-
Get Call Transcript
Tool to retrieve call transcripts from Gong. Use when you need to access the text content of calls with speaker information, timestamps, and topic categorization. Requires either a date range or specific call IDs to…
-
Get Crm Integration Details
Retrieves details of generic CRM integrations registered with Gong. This endpoint returns generic CRM integrations that were set up using the PUT /v2/crm/integrations endpoint. It does NOT return native integrations…
-
Get Crm Objects V2 Crm Entities
Retrieves specific CRM objects by their IDs from Gong's CRM integration. Use this endpoint to fetch detailed information about CRM entities (accounts, contacts, deals, or leads) that have been uploaded to Gong through…
-
Get CRM Request Status
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…
-
Get Flow Prospects
Tool to retrieve Gong Engage flows assigned to specified prospects. Use when you need to get flow instance IDs and details for specific CRM prospect IDs. Requires 'api:flows:read' scope.
-
Get Interaction Statistics
Tool to retrieve interaction trend statistics for users based on calls with Whisper enabled. Use when analyzing user interaction patterns, measuring engagement metrics, or tracking communication behaviors over a…
-
Get Permission Profile
Returns a permission profile.
-
Get User by ID
Tool to retrieve individual user details by user ID. Use when you need to fetch specific user information including profile data, settings, and organizational details.
-
Get User Call Access
Retrieves a list of users who have been granted individual access to specific calls through the API. This endpoint returns only users with explicit API-granted access and doesn't include users who have access through…
-
Get User Settings History
Tool to retrieve historical changes to a user's settings. Use when you need to track capability modifications for a specific user identified by their Gong ID.
-
List All Coaching Metrics V2 Coaching
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'.
-
List All Company Workspaces V2 Workspaces
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'.
-
List All Users V2 Users
List all of the company's users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.
-
List Call Outcomes
Tool to retrieve all available call outcomes defined in Gong. Use when you need to list all call outcome configurations including their categories, sentiments, and automation settings.
-
List Flow Folders
Tool to list all Gong Engage flow folders with visibility types. Use when you need to retrieve company flow folders, personal folders, and folders shared with a specific user.
-
List Folder Calls
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'.
-
List Gong Engage Flows V2 Flows
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…
-
List Schema Fields V2 Crm Entity Schema
Retrieves schema fields for a specific CRM object type within a Generic CRM integration. Returns field metadata including names, data types (STRING, NUMBER, PICKLIST, etc.), labels, reference relationships, and…
-
List Scorecards
Tool to retrieve all scorecards within the Gong system. Use when you need to list all scorecard configurations and their associated assessment questions.
-
List Tasks
Tool to retrieve Engage tasks assigned to a specific user with filtering options. Use when you need to list tasks by status, action type, and other criteria. Requires 'api:tasks:read' scope.
-
List Users by Filter V2 Users Extensive
List multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.
-
Post a Digital Interaction V2 Digital Interaction
When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'.
-
Post Day by Day Activity Stats
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…
-
Register Crm Integration
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…
-
Report Content Share Event
Tool to push content share engagement events to Gong's activity timeline. Use when documenting that a Gong user shared content with external participants such as contracts or proposals.
-
Report Content View Event
Tool to log content view engagement events to Gong's activity timeline. Use when tracking external participants viewing shared content like documents or presentations.
-
Report Custom Engagement Event
Report custom engagement events to Gong's activity timeline. Use this action to track when external participants (prospects, customers) engage with content such as viewing documents, signing contracts, attending…
-
Retrieve Activity Scorecards Report
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…
-
Retrieve Call Data by Date Range V2 Calls
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'.
-
Retrieve Data Privacy Info for Email Address
Retrieves data privacy information for a third-party email address. Shows all elements in the Gong system that reference the given email address, including calls, email messages, meetings, customer data, and engagement…
-
Retrieve Filtered Call Details
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…
-
Retrieve Library Folders V2 Library Folders
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…
-
Retrieve Logs Data by Type and Time Range V2 Logs
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'.
-
Retrieve Manual Crm Call Associations
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…
-
Retrieve Tracker Details V2 Settings Trackers
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.
-
Retrieve Users From Permission Profile
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'.
-
Set User Call Access
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…
-
Unassign Flows by CRM ID
Tool to unassign flows from prospects by their CRM Prospect ID. Use when you need to remove a prospect from specific flows or all flows in Gong Engage.
-
Update a Gong Meeting V2 Meetings Meetingid
When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.
-
Update Permission Profile V2 Permission Profile
Update a permission profile.
-
Upload Crm Objects V2 Crm Entities
Uploads CRM entity data to Gong via LDJSON file. Use this to insert, update, or delete CRM entities (Accounts, Contacts, Deals, Leads, Stages, Business Users) in Gong's platform. The file should be in LDJSON format…
-
Validate Meeting Integration
Validates Gong meeting integration status for one or more users by their email addresses. This endpoint checks if users have their meeting integration properly configured in Gong. Returns status information including…
Setup
Connect Gong in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
