---
title: "Report event of a content view"
slug: "report-event-of-a-content-view-v2customer-engagementcontentviewed"
updated: 2025-11-17T08:10:53Z
published: 2025-11-17T08:12:09Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.gong.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Report event of a content view (/v2/customer-engagement/content/viewed)

Put/v2/customer-engagement/content/viewed

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'.

Body parameters<select class='api-response-data' aria-label='Media type'><option value='c32fa793-549b-4657-bdf9-5433496a2b74'>application/json</option>
</select>Expand Allobject  

Content Viewed event

reportingSystemstring    Required

The unique identifier of the reporting system. It is the same value in all events originating from the same system.

Exampleabc123
eventTimestampstring    Required

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);

Example2021-02-17T02:30:00-08:00
eventIdstring    

The original id of the event as designated in the reporting system.

Exampleabc123
contentIdstring    Required

The id of the content that was viewed in the reporting system.

Exampledoc_123456789
contentUrlstring    Required

The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer.

Examplehttps://example.com/doc_123456789
contentTitlestring    Required

Human readable title of the content.

ExampleFeatures & Spec V.1
viewActionTitlestring    

The name of the action like "Document Viewed" or "Presentation Opened".

ExampleMy Title
shareIdstring    

The id of the share action that corresponds to this view event, in case there can be more than one share per content.

Exampleabc123
viewInfoUrlstring    

The link to a page that presents additional information about this event.

Examplehttps://example.com/path/to/a/page
viewerobject (Actor)  emailstring    

The email address of the person, if available.

Exampletest@test.com
namestring    

The name of the person, if available.

ExampleTest User
titlestring    

The title of the person, if available.

ExampleEnterprise Account Executive
context Array of object (PartyUploadContext)   

A list of links to external systems such as CRM, Telephony System, Case Management, etc.

object  

Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.

systemstring    Required

External system name. Currently only Salesforce and Generic are supported.

Valid values[
  "Salesforce",
  "HubSpot",
  "MicrosoftDynamic",
  "Generic"
]ExampleSalesforce
objects Array of object (ExternalCrmPartyObject)   

List of objects within the external system

object  

External object associated with the party

objectTypestring    Required

Object Type. Valid only for non-company parties. e.g. Lead.

Valid values[
  "Lead",
  "Contact",
  "Account",
  "Opportunity",
  "User",
  "Lead,Contact"
]ExampleContact
objectIdstring    Required

Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.

Example0013601230sV7grAAC
fields Array of object (CrmPartyContextField)   

Object fields. Intended for future use only.

object  

External object data

namestring    

Field name

Examplename
valueobject  

Object value

ExampleGong Inc.

crmContext Array of object (CallUploadContext)   

A list of references to external systems such as CRM, Telephony System, Case Management, etc.

object  

Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.

systemstring    Required

External system name. Currently only Salesforce and Generic are supported.

Valid values[
  "Salesforce",
  "HubSpot",
  "MicrosoftDynamic",
  "Generic"
]ExampleSalesforce
objects Array of object (ExternalCrmCallObject)   

List of objects within the external system. Note: Multiple opportunities/deals belonging to the same account are not supported.

object  

External object associated with the call

objectTypestring    Required

Object Type. e.g. Account.

Valid values[
  "Opportunity",
  "Account",
  "Lead",
  "Contact",
  "User",
  "Opportunity,Account"
]ExampleAccount
objectIdstring    Required

Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.

Example0013601230sV7grAAC
fields Array of object (ContextField)   

Object fields. Intended for future use only.

object  

External object data

namestring    

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.

Examplename
valueobject  

Field value

ExampleGong Inc.

contentProperties Array of object (Generic Property)   

A list of additional properties for the content

object  

A list of additional properties for the event

namestring    Required

Property name.

valuestring    Required

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"

Examplestring
dataTypestring    Required

Property data type.

Valid values[
  "number, string, url, date"
]Examplestring

eventProperties Array of object (Generic Property)   

A list of additional properties for the event

object  

A list of additional properties for the event

namestring    Required

Property name.

valuestring    Required

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"

Examplestring
dataTypestring    Required

Property data type.

Valid values[
  "number, string, url, date"
]Examplestring

userAgentstring    

"User-Agent" header value for browser based interaction

mobileAppIdstring    

The application identification string in case of interaction via mobile application (bundle identifier or package name).

agentPlatformstring    

Platform on which the interaction was made

Valid values[
  "Windows, Linux, MacOS, iOS, Android"
]
workspaceIdstring    

Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.

Example623457276584334
trackingIdstring    

The ID used for tracking the person who did the event. Must be null if a viewer is sent instead.

nonCompanyParticipants Array of object (Actor)   object  emailstring    

The email address of the person, if available.

Exampletest@test.com
namestring    

The name of the person, if available.

ExampleTest User
titlestring    

The title of the person, if available.

ExampleEnterprise Account Executive
context Array of object (PartyUploadContext)   

A list of links to external systems such as CRM, Telephony System, Case Management, etc.

object  

Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.

systemstring    Required

External system name. Currently only Salesforce and Generic are supported.

Valid values[
  "Salesforce",
  "HubSpot",
  "MicrosoftDynamic",
  "Generic"
]ExampleSalesforce
objects Array of object (ExternalCrmPartyObject)   

List of objects within the external system

object  

External object associated with the party

objectTypestring    Required

Object Type. Valid only for non-company parties. e.g. Lead.

Valid values[
  "Lead",
  "Contact",
  "Account",
  "Opportunity",
  "User",
  "Lead,Contact"
]ExampleContact
objectIdstring    Required

Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.

Example0013601230sV7grAAC
fields Array of object (CrmPartyContextField)   

Object fields. Intended for future use only.

object  

External object data

namestring    

Field name

Examplename
valueobject  

Object value

ExampleGong Inc.

moreInfoUrlstring    
actionNamestring    
sharingMessageSubjectstring    
sharingMessageBodystring    
sharerobject (Sharer)  idstring    

The user id in Gong, if available.

Example234599484848423
emailstring    

The email address of the person, if available.

Exampletest@test.com
namestring    

The name of the person, if available.

ExampleTest User

Responses200

Successful response

<select class='api-response-data' aria-label='Media type'><option value='f15c72a4-5956-46fb-a084-2ae40918babb'>*/*</option>
</select>object  requestIdstring    

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
integrationIdinteger  (int64)    <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>Your integration ID to be used in requests to the API. This ensures you are accessing the correct integration.  
**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.
Example5517027188234206000

400

Malformed request

<select class='api-response-data' aria-label='Media type'><option value='f408e3a0-eedf-46c3-be1e-b08a34e05042'>*/*</option>
</select>object  requestIdstring    

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors Array of string   

Error messages.

Example[
  "An error has occurred"
]string    

401

Access denied

<select class='api-response-data' aria-label='Media type'><option value='47bc383a-120a-405c-a23d-549b777fb7d9'>*/*</option>
</select>object  requestIdstring    

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors Array of string   

Error messages.

Example[
  "An error has occurred"
]string    

409

Conflict - Event was already reported in the past.

<select class='api-response-data' aria-label='Media type'><option value='d8dc52e4-4d19-4cff-9560-ed0db2ddb850'>*/*</option>
</select>object  requestIdstring    

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors Array of string   

Error messages.

Example[
  "An error has occurred"
]string    

429

API request limit exceeded

HeadersRetry-AfterintegerNumber of seconds to wait before making a new request.
<select class='api-response-data' aria-label='Media type'><option value='56cf4c3e-7832-4b1c-afc3-75ba923130ae'>*/*</option>
</select>object  requestIdstring    

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors Array of string   

Error messages.

Example[
  "An error has occurred"
]string    

500

Failed to complete the operation due to an unexpected error

<select class='api-response-data' aria-label='Media type'><option value='05d9e203-381a-4639-9348-de1ec8192945'>*/*</option>
</select>object  requestIdstring    

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors Array of string   

Error messages.

Example[
  "An error has occurred"
]string