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)
Required authorizaton scope: 'api:engagement-data:write'.
Content Viewed event
The unique identifier of the reporting system. It is the same value in all events originating from the same system.
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);
The original id of the event as designated in the reporting system.
The id of the content that was viewed in the reporting system.
The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer.
Human readable title of the content.
The name of the action like "Document Viewed" or "Presentation Opened".
The id of the share action that corresponds to this view event, in case there can be more than one share per content.
The link to a page that presents additional information about this event.
The email address of the person, if available.
The name of the person, if available.
The title of the person, if available.
A list of links to external systems such as CRM, Telephony System, Case Management, etc.
Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.
External system name. Currently only Salesforce and Generic are supported.
List of objects within the external system
External object associated with the party
Object Type. Valid only for non-company parties. e.g. Lead.
Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.
Object fields. Intended for future use only.
External object data
Field name
Object value
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.
External system name. Currently only Salesforce and Generic are supported.
List of objects within the external system. Note: Multiple opportunities/deals belonging to the same account are not supported.
External object associated with the call
Object Type. e.g. Account.
Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.
Object fields. Intended for future use only.
External object data
Field name. For Account supported fields are: Name, Website, Industry and all the custom fields. For Opportunity supported fields are Name, LeadSource, Type, StageName, Probability, Amount, CloseDate and all the custom fields.
Field value
A list of additional properties for the content
A list of additional properties for the event
Property name.
Property value. Value format should match dataType. If dataType is "number", value should be passed in JSON number format, e.g. 3.14. If dataType is "date", the value should be passed in JSON date format, e.g. 2021-02-17T02:30:00-08:00. If the dataType is "url", the value should be valid URL, e.g. "https://example.com/example?q=v"
Property data type.
A list of additional properties for the event
A list of additional properties for the event
Property name.
Property value. Value format should match dataType. If dataType is "number", value should be passed in JSON number format, e.g. 3.14. If dataType is "date", the value should be passed in JSON date format, e.g. 2021-02-17T02:30:00-08:00. If the dataType is "url", the value should be valid URL, e.g. "https://example.com/example?q=v"
Property data type.
"User-Agent" header value for browser based interaction
The application identification string in case of interaction via mobile application (bundle identifier or package name).
Platform on which the interaction was made
Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
The ID used for tracking the person who did the event. Must be null if a viewer is sent instead.
The email address of the person, if available.
The name of the person, if available.
The title of the person, if available.
A list of links to external systems such as CRM, Telephony System, Case Management, etc.
Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.
External system name. Currently only Salesforce and Generic are supported.
List of objects within the external system
External object associated with the party
Object Type. Valid only for non-company parties. e.g. Lead.
Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.
Object fields. Intended for future use only.
External object data
Field name
Object value
The user id in Gong, if available.
The email address of the person, if available.
The name of the person, if available.
Successful response
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Note: Parse the integrationId as Long or BigInt. Parsing the integrationId as an Integer will truncate the integrationId to trailing zeros and will return an incorrect ID.
Malformed request
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Access denied
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Conflict - Event was already reported in the past.
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
API request limit exceeded
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Failed to complete the operation due to an unexpected error
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.