Gong Component

Captures customer interactions then delivers insights at scale, empowering teams to make decisions based on data instead of opinions. Use the Gong Component to manage calls, users, libraries, and more.

Component key: gong

Description

Gong captures customer interactions then delivers insights at scale, empowering teams to make decisions based on data instead of opinions.

Use the Gong Component to manage calls, users, libraries, and more.

Connections

API Key

To generate a Gong API key manually:

Log in to Gong and click Company Settings > Ecosystem > API.
Click Create to generate an access key and the access key secret.
Take note of the API Base URL that is displayed next to the access key and access key secret.

Input	Notes	Example
Access Key string / Required accessKey
Access Key Secret password / Required accessKeySecret
Base URL string / Required baseUrl		https://us-0000.api.gong.io

Gong OAuth 2.0

To Create an OAuth app for Gong:

In your company's Settings page, click API and click the Integrations tab.
Click Create Integration.
In the Integration details area, enter your integration name and a description.
In the Required authorization scopes area, select the scopes that your app needs. You can check our API documentation to see which APIs use which scopes.
Add Redirect URI as https://oauth2.prismatic.io/callback
Click Save.

A new row appears in the table of apps, containing the Client ID and the Client Secret. Copy and paste these into the connection configuration of your Prismatic integration.

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://app.gong.io/oauth2/authorize	The OAuth 2.0 Authorization URL for Gong
API Key string / Required clientId		Obtain this by creating an app at your Gong Dashboard
API Secret password / Required clientSecret		Obtain this by creating an app at your Gong Dashboard
Scopes string scopes	api:calls:create api:calls:read:basic	A space-delimited set of one or more scopes to get the user's permission to access. A list of all scopes is available at https://app.gong.io/settings/api/documentation#overview
Token URL string / Required Hidden Field tokenUrl	https://app.gong.io/oauth2/generate-customer-token	The OAuth 2.0 Token URL for Gong

Triggers

Process Automation Trigger

Trigger for handling process automations from Gong | key: webhook

Input	Notes
Automation Rules jsonform / Required rules

Data Sources

Fetch Folders

Fetch an array of Folders | key: folders | type: picklist

Input	Notes	Example
Connection connection / Required connection
Workspace Id string / Required workspaceId	Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Example Payload for Fetch Folders

{
  "result": [
    {
      "label": "Sales Onboarding",
      "key": "3843152912968920037"
    }
  ]
}

Fetch Workspaces

Fetch an array of Workspaces | key: workspaces | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Fetch Workspaces

{
  "result": [
    {
      "label": "Sales Onboarding",
      "key": "3843152912968920037"
    }
  ]
}

Actions

Add Call Media

Adds a call media, recorded by a telephony system (PBX) or other media recording facility. | key: addMedia

Input	Notes	Example
Call Id string / Required callId	callId returned from 'Add New Call' request	1230788881967087399
Connection connection / Required connection
File data / Required fileInput	The media file of the recording. You may attach files up to 1.5GB in size.	Some binary file
File Name string / Required fileName	The name of the file	some-file-name.txt

Create New Call

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. | key: createNewCall

Input	Notes	Example
Actual Start string / Required actualStart	The actual date and time when the call started in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)	2018-02-18T02:30:00-07:00
Call Provider Code string callProviderCode	The code identifies the provider conferencing or telephony system. For example: zoom, clearslide, gotomeeting, ringcentral, outreach, insidesales, etc. These values are predefined by Gong, please contact help@gong.io to find the proper value for your system.	clearslide
Client Unique Id string / Required clientUniqueId	A call's unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording.	1230788881967087399
Connection connection / Required connection
Context code contextParam	A list of references to external systems such as CRM, Telephony System, Case Management, etc.
Custom Data string customData	Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting.	Optional data
Direction string / Required direction	Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.	Inbound
Disposition string disposition	The disposition of the call. The disposition is free text of up to 255 characters.	No Answer
Download Media URL string downloadMediaUrl	The URL from which Gong can download the media file. The URL must be unique, the audio or video file must be a maximum of 1.5GB. If you provide this URL, you should not perform the 'Add call media' step.	https://upload-server.com/sample-call.mp3
Duration string duration	The actual call duration in seconds.	125.8
Language Code string languageCode	The language code the call should be transcribed to. This field is optional as Gong automatically detects the language spoken in the call and transcribes it accordingly. Set this field only if you are sure of the language the call is in. Valid values are: af-ZA, am-ET, ar-AE, ar-BH, ar-DZ, ar-EG, ar-IL, ar-IQ, ar-JO, ar-KW, ar-LB, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-TN, ar-YE, az-AZ, bg-BG, bn-BD, bn-IN, bs-BA, ca-ES, cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AB, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-PH, en-SG, en-US, en-WL, en-ZA, es-AR, es-BO, es-CL, es-CO, es-CR, es-DO, es-EC, es-ES, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PR, es-PY, es-SV, es-US, es-UY, et-EE, eu-ES, fa-IR, fi-FI, fil-PH, fr-BE, fr-CA, fr-CH, fr-FR, gl-ES, gu-IN, he-IL, hi-IN, hr-HR, hu-HU, hy-AM, id-ID, is-IS, it-CH, it-IT, ja-JP, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko-KR, lo-LA, lt-LT, lv-LV, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, my-MM, ne-NP, nl-BE, nl-NL, no-NO, pa-Guru-IN, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, si-LK, sk-SK, sl-SI, sq-AL, sr-RS, su-ID, sv-SE, sw-KE, sw-TZ, ta-IN, ta-LK, ta-MY, ta-SG, te-IN, th-TH, tr-TR, uk-UA, ur-IN, ur-PK, uz-UZ, vi-VN, yue-Hant-HK, zh-CN, zh-TW, zu-ZA	en-US
Meeting URL string meetingUrl	The URL of the conference call by which users join the meeting	https://www.conference.com/john.smith
Parties code / Required parties	A list of the call's participants. A party must be provided for the primaryUser.
Primary User string / Required primaryUser	The Gong internal user ID of the team member who hosted the call.	234599484848423
Purpose string purpose	The purpose of the call. This optional field is a free text of up to 255 characters.	Demo call
Scheduled End string scheduledEnd	The date and time the call was scheduled to end in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)	2018-02-18T02:30:00-07:00
Scheduled Start string scheduledStart	The date and time the call was scheduled to begin in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC)	2018-02-18T02:30:00-07:00
Speakers Timeline code speakersTimeline	The audio recording speech segments (who spoke when). Note that speakersTimeline and mediaChannelId are mutually exclusive, when providing speakersTimeline - mediaChannelId will not be used.
Title string title	The title of the call. This title is available in the Gong system for indexing and search.	Example call
Workspace Id string workspaceId	Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Create New Gong Meeting

Creates a new Gong Meeting | key: createNewGongMeeting

Input	Notes	Example
Connection connection / Required connection
End Time string / Required endTime	The meeting end time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).	2018-02-18T02:30:00-07:00
External ID string externalId	The ID as it is formed on the external system.	7JEHFRGXDDZFEW2FC4U
Invitees code / Required invitees	A list of email addresses of invitees to the event (not including the organizer).
Organizer Email string / Required organizerEmail	The email address of the user creating the meeting, the Gong consent page link will be used according to the settings of this user.	test@test.com
Start Time string / Required startTime	The meeting start time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).	2018-02-18T02:30:00-07:00
Title string title	The title of the call. This title is available in the Gong system for indexing and search.	Example call

Example Payload for Create New Gong Meeting

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "meetingId": "7782342274025937895",
    "meetingUrl": "https://join.gong.io/my-company/jon.snow?tkn=MoNpS9tMNt8BK7EZxQpSJl",
    "additionalInvitees": [
      {
        "displayName": "Gong Assistant",
        "email": "assistant@gong.io"
      }
    ]
  }
}

Custom Action Event

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) | key: customActionEvent

Input	Notes	Example
Action Name string actionName	The name of the action like 'Document Viewed' or 'Presentation Opened'.	Document Viewed
Actor code actor
Agent Platform string agentPlatform	Platform on which the interaction was made	Windows
Connection connection / Required connection
Content Id string contentId	The id of the content that was viewed in the reporting system.	7782342223025937895
Content Properties code contentProperties
Content Title string contentTitle	Human readable title of the content.	Features & Spec V.1
Content Url string contentUrl	The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer.	https://example.com/doc_123456789
CRM Context code crmContext
Event Id string eventId	The original id of the event as designated in the reporting system.	7782342274025932395
Event Info Url string eventInfoUrl	The link to a page that presents additional information about this event.	https://example.com/path/to/a/page
Event Properties code eventProperties
Event Timestamp string / Required eventTimestamp	The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC);	2018-02-18T02:30:00-07:00
Mobile App Id string mobileAppId	The application identification string in case of interaction via mobile application (bundle identifier or package name).	com.example.app
More Info Url string moreInfoUrl		https://example.com/path/to/a/page
Non Company Participants code nonCompanyParticipants
Reporting System string / Required reportingSystem	The unique identifier of the reporting system. It is the same value in all events originating from the same system.	abc123
Share Id string shareId		7782342223025937895
Sharer code sharer
Sharing Message Body string sharingMessageBody	The share message body. Can contain HTML and will be cleaned when it is presented.	Check out this document
Sharing Message Subject string sharingMessageSubject	The subject of share email / message.	Check out this document
User Agent string userAgent	'User-Agent' header value for browser based interaction	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
Workspace Id string workspaceId	Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Example Payload for Custom Action Event

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "integrationId": 55170271882342
  }
}

Custom Shared Event

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) | key: customSharedEvent

Input	Notes	Example
Action Name string actionName	The name of the action like 'Document Viewed' or 'Presentation Opened'.	Document Viewed
Agent Platform string agentPlatform	Platform on which the interaction was made	Windows
Connection connection / Required connection
Content Id string / Required contentId	The id of the content that was shared in the reporting system.	7782342223025937895
Content Properties code contentProperties
Content Title string / Required contentTitle	Human readable title of the content.	Features & Spec V.1
Content Url string / Required contentUrl	The url of the content that was shared in the reporting system. This is the url that is was accessed by the viewer.	https://example.com/doc_123456789
CRM Context code crmContext
Event Id string eventId	The original id of the event as designated in the reporting system.	7782342274025932395
Event Properties code eventProperties
Event Timestamp string / Required eventTimestamp	The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC);	2018-02-18T02:30:00-07:00
Mobile App Id string mobileAppId	The application identification string in case of interaction via mobile application (bundle identifier or package name).	com.example.app
More Info Url string moreInfoUrl		https://example.com/path/to/a/page
Non Company Participants code nonCompanyParticipants
Recipients code recipients
Reporting System string / Required reportingSystem	The unique identifier of the reporting system. It is the same value in all events originating from the same system.	abc123
Share Id string shareId		7782342223025937895
Share Info Url string shareInfoUrl	The link to a page that presents additional information about this event.	https://example.com/path/to/a/page
Sharer code sharer
Sharing Message Body string sharingMessageBody	The share message body. Can contain HTML and will be cleaned when it is presented.	Check out this document
Sharing Message Subject string sharingMessageSubject	The subject of share email / message.	Check out this document
User Agent string userAgent	'User-Agent' header value for browser based interaction	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
Workspace Id string workspaceId	Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Example Payload for Custom Shared Event

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "integrationId": 55170271882342
  }
}

Custom Viewed Event

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) | key: customViewedEvent

Input	Notes	Example
Action Name string actionName	The name of the action like 'Document Viewed' or 'Presentation Opened'.	Document Viewed
Agent Platform string agentPlatform	Platform on which the interaction was made	Windows
Connection connection / Required connection
Content Id string / Required contentId	The id of the content that was shared in the reporting system.	7782342223025937895
Content Properties code contentProperties
Content Title string / Required contentTitle	Human readable title of the content.	Features & Spec V.1
Content Url string / Required contentUrl	The url of the content that was shared in the reporting system. This is the url that is was accessed by the viewer.	https://example.com/doc_123456789
CRM Context code crmContext
Event Id string eventId	The original id of the event as designated in the reporting system.	7782342274025932395
Event Properties code eventProperties
Event Timestamp string / Required eventTimestamp	The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC);	2018-02-18T02:30:00-07:00
Mobile App Id string mobileAppId	The application identification string in case of interaction via mobile application (bundle identifier or package name).	com.example.app
More Info Url string moreInfoUrl		https://example.com/path/to/a/page
Non Company Participants code nonCompanyParticipants
Reporting System string / Required reportingSystem	The unique identifier of the reporting system. It is the same value in all events originating from the same system.	abc123
Share Id string shareId		7782342223025937895
Sharer code sharer
Sharing Message Body string sharingMessageBody	The share message body. Can contain HTML and will be cleaned when it is presented.	Check out this document
Sharing Message Subject string sharingMessageSubject	The subject of share email / message.	Check out this document
User Agent string userAgent	'User-Agent' header value for browser based interaction	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
View Action Title string viewActionTitle	The name of the action like 'Document Viewed' or 'Presentation Opened'.	Document Viewed
Viewer code viewer
View Info URL string viewInfoUrl	The link to a page that presents additional information about this event.	https://example.com/path/to/a/page
Workspace Id string workspaceId	Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Example Payload for Custom Viewed Event

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "integrationId": 55170271882342
  }
}

Delete Email Address and Associated Elements

Given an email address, this endpoint deletes from the Gong system any calls or email messages that reference this address. | key: deleteEmailAddressAndAssociatedElements

Input	Notes	Example
Connection connection / Required connection
Email Address string / Required emailAddress	The email address.	test@test.com

Example Payload for Delete Email Address and Associated Elements

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw"
  }
}

Delete Gong Meeting

Deletes an existing Gong Meeting | key: deleteMeeting

Input	Notes	Example
Connection connection / Required connection
Meeting ID string / Required meetingId	Gong's unique identifier for the meeting (up to 20 digits).	7782342274025937895

Example Payload for Delete Gong Meeting

{
  "data": {
    "organizerEmail": "test@test.com"
  }
}

Delete Phone Number and Associated Elements

Given a phone number, this endpoint deletes from the Gong system any leads or contacts with a matching phone number or mobile phone number. | key: deletePhoneNumberAndAssociatedElements

Input	Notes	Example
Connection connection / Required connection
Phone Number string / Required phoneNumber	The phone number. This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored. The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.	+1 425 555 2671

Example Payload for Delete Phone Number and Associated Elements

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw"
  }
}

Get Call

Retrieve data for a specific call (/v2/calls/[id]) | key: getCallUsingGet

Input	Notes	Example
Call Id string / Required callId	Gong's unique numeric identifier for the call (up to 20 digits)	1230788881967087399
Connection connection / Required connection

Example Payload for Get Call

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "call": {
      "id": "7782342274025937895",
      "url": "https://app.gong.io/call?id=7782342274025937895",
      "title": "Example call",
      "scheduled": 1518863400,
      "started": 1518863400,
      "duration": 460,
      "primaryUserId": "234599484848423",
      "direction": "Inbound",
      "system": "Outreach",
      "scope": "Internal",
      "media": "Video",
      "language": "eng",
      "workspaceId": "623457276584334",
      "sdrDisposition": "Got the gatekeeper",
      "clientUniqueId": "7JEHFRGXDDZFEW2FC4U",
      "customData": "Conference Call",
      "purpose": "Demo Call",
      "meetingUrl": "https://zoom.us/j/123",
      "isPrivate": false,
      "calendarEventId": "abcde@google.com"
    }
  }
}

Get Call Transcript

Returns transcripts for calls that took place during the specified date period. | key: getCallTranscript

Input	Default	Notes	Example
Call Ids string Value List callIds	000xxx	List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.	7782342274025937895
Connection connection / Required connection
Cursor string cursor		When paging is needed, provide the value supplied by the previous API call to bring the following page of records.	eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM
From Date Time string fromDateTime		Date and time (in ISO-8601 format: '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.	2018-02-18T02:30:00-07:00
To Date Time string toDateTime		Date and time (in ISO-8601 format: '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC) until which to list recorded calls. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.	2018-02-18T02:30:00-07:00
Workspace Id string workspaceId		Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Example Payload for Get Call Transcript

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "records": {
      "totalRecords": 263,
      "currentPageSize": 100,
      "currentPageNumber": 0,
      "cursor": "eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"
    },
    "callTranscripts": [
      {
        "callId": "7782342274025937895",
        "transcript": [
          {
            "speakerId": "6432345678555530067",
            "topic": "Objections",
            "sentences": [
              {
                "start": 460230,
                "end": 462343,
                "text": "No wait, I think we should check that out first."
              }
            ]
          }
        ]
      }
    ]
  }
}

Get Logs Data by Type and Time Range

List log entries that took place during a specified time range. | key: getLogsDataByTypeAndTimeRange

Input	Notes	Example
Connection connection / Required connection
Cursor string cursor	When paging is needed, provide the value supplied by the previous API call to bring the following page of records.	eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM
From Date Time string / Required fromDateTime	Date and time (in ISO-8601 format: '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.	2018-02-18T02:30:00-07:00
Log Type string / Required logType	Type of logs requested.
To Date Time string toDateTime	The time until which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the logs end with the latest recorded log.	2018-02-18T02:30:00-07:00

Example Payload for Get Logs Data by Type and Time Range

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "records": {
      "totalRecords": 263,
      "currentPageSize": 100,
      "currentPageNumber": 0,
      "cursor": "eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"
    },
    "logEntries": [
      {
        "userId": "234599484848423",
        "userEmailAddress": "test@test.com",
        "userFullName": "Jon Snow",
        "impersonatorUserId": "234599484848423",
        "impersonatorEmailAddress": "test@test.com",
        "impersonatorFullName": "Jon Snow",
        "impersonatorCompanyId": "234599484848423",
        "eventTime": "2018-02-17T02:30:00-08:00",
        "logRecord": {}
      }
    ]
  }
}

Get User

Retrieve a specific user. | key: getUser

Input	Notes	Example
Connection connection / Required connection
User Id string / Required userId	Gong's unique numeric identifier for the user (up to 20 digits).	1230788881967087399

Example Payload for Get User

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "user": {
      "id": "234599484848423",
      "emailAddress": "test@test.com",
      "created": "2018-02-17T02:30:00-08:00",
      "active": true,
      "emailAliases": [
        "testAlias@test.com"
      ],
      "trustedEmailAddress": "test@test.com",
      "firstName": "Jon",
      "lastName": "Snow",
      "title": "Enterprise Account Executive",
      "phoneNumber": "+1 123-567-8989",
      "extension": "123",
      "personalMeetingUrls": [
        "https://zoom.us/j/123"
      ],
      "settings": {
        "webConferencesRecorded": true,
        "preventWebConferenceRecording": false,
        "telephonyCallsImported": false,
        "emailsImported": true,
        "preventEmailImport": false,
        "nonRecordedMeetingsImported": true,
        "gongConnectEnabled": true
      },
      "managerId": "563515258458745",
      "meetingConsentPageUrl": "https://join.gong.io/my-company/jon.snow?tkn=MoNpS9tMNt8BK7EZxQpSJl",
      "spokenLanguages": [
        {
          "language": "es-ES",
          "primary": true
        }
      ]
    }
  }
}

List Calls

Retrieve call data by date range (/v2/calls) | key: listCallsUsingGet

Input	Notes	Example
Connection connection / Required connection
Cursor string cursor	When paging is needed, provide the value supplied by the previous API call to bring the following page of records.	eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM
From Date Time string / Required fromDateTime	Date and time (in ISO-8601 format: '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.	2018-02-18T02:30:00-07:00
To Date Time string / Required toDateTime	Date and time (in ISO-8601 format: '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC) until which to list recorded calls. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.	2018-02-18T02:30:00-07:00
Workspace Id string workspaceId	Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Example Payload for List Calls

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "records": {
      "totalRecords": 263,
      "currentPageSize": 100,
      "currentPageNumber": 0,
      "cursor": "eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"
    },
    "calls": [
      {
        "id": "7782342274025937895",
        "url": "https://app.gong.io/call?id=7782342274025937895",
        "title": "Example call",
        "scheduled": 1518863400,
        "started": 1518863400,
        "duration": 460,
        "primaryUserId": "234599484848423",
        "direction": "Inbound",
        "system": "Outreach",
        "scope": "Internal",
        "media": "Video",
        "language": "eng",
        "workspaceId": "623457276584334",
        "sdrDisposition": "Got the gatekeeper",
        "clientUniqueId": "7JEHFRGXDDZFEW2FC4U",
        "customData": "Conference Call",
        "purpose": "Demo Call",
        "meetingUrl": "https://zoom.us/j/123",
        "isPrivate": false,
        "calendarEventId": "abcde@google.com"
      }
    ]
  }
}

List Calls in Folder

Given a folder id, this endpoint retrieves a list of calls in it. | key: listCallsInFolder

Input	Notes	Example
Connection connection / Required connection
Folder Id string folderId	Gong's unique numeric identifier for the folder (up to 20 digits).	1230788881967087399

Example Payload for List Calls in Folder

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "id": "3843152912968920037",
    "name": "Sales Onboarding",
    "createdBy": "234599484848423",
    "updated": 1584192600,
    "calls": [
      {
        "id": "7782342274025937895",
        "title": "Example call",
        "note": "sample note",
        "addedBy": "234599484848423",
        "created": 1578868200,
        "url": "https://app.gong.io/call?id=3636865806219496180&highlights=%5B%7B%22to%22%3A+3240%2C+%22from%22%3A+1200%2C+%22type%22%3A+%22LIBRARY%22%7D%5D",
        "snippet": {
          "fromSec": 21,
          "toSec": 132
        }
      }
    ]
  }
}

List Library Folders

Use this endpoint to retrieve a list of public library folders. | key: listLibraryFolders

Input	Notes	Example
Connection connection / Required connection
Workspace Id string workspaceId	Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.	1230788881967087399

Example Payload for List Library Folders

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "folders": [
      {
        "id": "3843152912968920037",
        "name": "Sales Onboarding",
        "parentFolderId": "295738305212375930",
        "createdBy": "234599484848423",
        "updated": 1584192600
      }
    ]
  }
}

List References to a Phone Number

Shows the elements in the Gong system that reference the given phone number. | key: listReferencesToAPhoneNumber

Input	Notes	Example
Connection connection / Required connection
Phone Number string / Required phoneNumber	The phone number. This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored. The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.	+1 425 555 2671

Example Payload for List References to a Phone Number

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "emails": [
      {
        "from": "test@test.com",
        "id": "223mjfaaqqjuegabiyrmpctvcwwl75oz",
        "sentTime": "2019-01-20T00:00:00-08:00",
        "mailbox": "test@test.com",
        "messageHash": "l3z7w2s7oircdabnkwizmycm6g2uwznc"
      }
    ],
    "calls": [
      {
        "id": "7782342274025937895",
        "status": "COMPLETED",
        "externalSystems": [
          {
            "system": "Salesforce",
            "objects": [
              {
                "objectType": "Task",
                "externalId": "0013601230sV7grAAC"
              }
            ]
          }
        ]
      }
    ],
    "meetings": [
      {
        "id": "8059707022269524529.sb5gr1tgpt5dd799eh035rb3dk@google.com_2022-06-30T13:00:00Z"
      }
    ],
    "customerData": [
      {
        "system": "Salesforce",
        "objects": [
          {
            "id": "7782342274025937895",
            "objectType": "Contact",
            "externalId": "0013601230sV7grAAC",
            "mirrorId": "\"{\\\"integrationId\\\":\\\"262834820328732\\\",\\\"crmObjectType\\\":\\\"CONTACT\\\",\\\"crmId\\\":\\\"0031Q00002DFhi4QAD\\\"}\"",
            "fields": [
              {
                "name": "name",
                "value": "Gong Inc."
              }
            ]
          }
        ]
      }
    ],
    "customerEngagement": [
      {
        "eventType": "ExternalCallViewing",
        "timestamp": 1547971200,
        "contentId": "7782342274025937895",
        "contentUrl": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i",
        "reportingSystem": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i",
        "eventName": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i",
        "sourceEventId": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i"
      }
    ]
  }
}

List References to an Email Address

Shows the elements in the Gong system that reference the given email address. | key: listReferencesToAnEmailAddress

Input	Notes	Example
Connection connection / Required connection
Email Address string / Required emailAddress	The email address.	test@test.com

Example Payload for List References to an Email Address

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "emails": [
      {
        "from": "test@test.com",
        "id": "223mjfaaqqjuegabiyrmpctvcwwl75oz",
        "sentTime": "2019-01-20T00:00:00-08:00",
        "mailbox": "test@test.com",
        "messageHash": "l3z7w2s7oircdabnkwizmycm6g2uwznc"
      }
    ],
    "calls": [
      {
        "id": "7782342274025937895",
        "status": "COMPLETED",
        "externalSystems": [
          {
            "system": "Salesforce",
            "objects": [
              {
                "objectType": "Task",
                "externalId": "0013601230sV7grAAC"
              }
            ]
          }
        ]
      }
    ],
    "meetings": [
      {
        "id": "8059707022269524529.sb5gr1tgpt5dd799eh035rb3dk@google.com_2022-06-30T13:00:00Z"
      }
    ],
    "customerData": [
      {
        "system": "Salesforce",
        "objects": [
          {
            "id": "7782342274025937895",
            "objectType": "Contact",
            "externalId": "0013601230sV7grAAC",
            "mirrorId": "\"{\\\"integrationId\\\":\\\"262834820328732\\\",\\\"crmObjectType\\\":\\\"CONTACT\\\",\\\"crmId\\\":\\\"0031Q00002DFhi4QAD\\\"}\"",
            "fields": [
              {
                "name": "name",
                "value": "Gong Inc."
              }
            ]
          }
        ]
      }
    ],
    "customerEngagement": [
      {
        "eventType": "ExternalCallViewing",
        "timestamp": 1547971200,
        "contentId": "7782342274025937895",
        "contentUrl": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i",
        "reportingSystem": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i",
        "eventName": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i",
        "sourceEventId": "https://app.gong.io/e/c-share/tkn=5vjaxkqnzmp515b220vlzto2i"
      }
    ]
  }
}

List Users

List all of the company's users. | key: listUsers

Input	Default	Notes	Example
Connection connection / Required connection
Cursor string cursor		When paging is needed, provide the value supplied by the previous API call to bring the following page of records.	eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM
Include Avatars boolean includeAvatars	false	Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars' IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.	false

Example Payload for List Users

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "records": {
      "totalRecords": 263,
      "currentPageSize": 100,
      "currentPageNumber": 0,
      "cursor": "eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM"
    },
    "users": [
      {
        "id": "234599484848423",
        "emailAddress": "test@test.com",
        "created": "2018-02-17T02:30:00-08:00",
        "active": true,
        "emailAliases": [
          "testAlias@test.com"
        ],
        "trustedEmailAddress": "test@test.com",
        "firstName": "Jon",
        "lastName": "Snow",
        "title": "Enterprise Account Executive",
        "phoneNumber": "+1 123-567-8989",
        "extension": "123",
        "personalMeetingUrls": [
          "https://zoom.us/j/123"
        ],
        "settings": {
          "webConferencesRecorded": true,
          "preventWebConferenceRecording": false,
          "telephonyCallsImported": false,
          "emailsImported": true,
          "preventEmailImport": false,
          "nonRecordedMeetingsImported": true,
          "gongConnectEnabled": true
        },
        "managerId": "563515258458745",
        "meetingConsentPageUrl": "https://join.gong.io/my-company/jon.snow?tkn=MoNpS9tMNt8BK7EZxQpSJl",
        "spokenLanguages": [
          {
            "language": "es-ES",
            "primary": true
          }
        ]
      }
    ]
  }
}

List Workspaces

Returns a list of all workspaces including their details. | key: listWorkspaces

Input	Notes
Connection connection / Required connection

Example Payload for List Workspaces

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "workspaces": [
      {
        "id": "623457276584334",
        "name": "Some Workspace",
        "description": "This is one of our workspaces"
      }
    ]
  }
}

Raw Request

Send raw HTTP request to Gong | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		This is the URL to call.	Input the path only (/v2/users), The base URL is already included (https://us-6852.app.gong.io/). For example, to connect to https://us-6852.app.gong.io/v2/users, only /v2/users is entered in this field.
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Update Gong Meeting

Updates an existing Gong Meeting | key: updateGongMeeting

Input	Notes	Example
Connection connection / Required connection
End Time string / Required endTime	The meeting end time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).	2018-02-18T02:30:00-07:00
External ID string externalId	The ID as it is formed on the external system.	7JEHFRGXDDZFEW2FC4U
Invitees code / Required invitees	A list of email addresses of invitees to the event (not including the organizer).
Meeting ID string / Required meetingId	Gong's unique identifier for the meeting (up to 20 digits).	7782342274025937895
Organizer Email string / Required organizerEmail	The email address of the user creating the meeting, the Gong consent page link will be used according to the settings of this user.	test@test.com
Start Time string / Required startTime	The meeting start time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).	2018-02-18T02:30:00-07:00
Title string title	The title of the call. This title is available in the Gong system for indexing and search.	Example call

Example Payload for Update Gong Meeting

{
  "data": {
    "requestId": "4al018gzaztcr8nbukw",
    "meetingId": "7782342274025937895",
    "meetingUrl": "https://join.gong.io/my-company/jon.snow?tkn=MoNpS9tMNt8BK7EZxQpSJl",
    "additionalInvitees": [
      {
        "displayName": "Gong Assistant",
        "email": "assistant@gong.io"
      }
    ]
  }
}

Captures customer interactions then delivers insights at scale, empowering teams to make decisions based on data instead of opinions. Use the Gong Component to manage calls, users, libraries, and more.

Description​

Connections​

API Key​

Gong OAuth 2.0​

Triggers​

Process Automation Trigger​

Data Sources​

Fetch Folders​

Fetch Workspaces​

Actions​

Add Call Media​

Create New Call​

Create New Gong Meeting​

Custom Action Event​

Custom Shared Event​

Custom Viewed Event​

Delete Email Address and Associated Elements​

Delete Gong Meeting​

Delete Phone Number and Associated Elements​

Get Call​

Get Call Transcript​

Get Logs Data by Type and Time Range​

Get User​

List Calls​

List Calls in Folder​

List Library Folders​

List References to a Phone Number​

List References to an Email Address​

List Users​

List Workspaces​

Raw Request​

Update Gong Meeting​