Required authorizaton scope: 'api:digital-interactions:write'.
Digital interaction metadata
The provider's unique identifier for the event used for deduplication
The date and time of the event in ISO 8601 format
The type of the event, explaining the content and action performed. Values may be partner-aligned, for example, "link clicked", "page viewed"
When integrating via IPaaS, the name of the technology partner the customer set up a Gong integration with via an IPaaS. When integrating directly with Gong: the name of the company setting up the integration with Gong
The identifier for the session, useful for tying related events together
The device used during the event
The content the person looked at
A unique identifier for the content in the partner's system
The title of the content
A list of tags defined for the content
A list of tags defined for the content
The URL for the content the person looked at
The URL for additional details provided by the website or external app, such as analysis of the content viewed
For content where there is a numeric result, such as NPS score, or metrics such as the percentage of video watched
The numeric value for the content
The lowest value that can be given to the content
The highest value that can be given to the content
The type of numeric value
For content where there are a number of steps to complete in the content, such as shipment tracking or course advancement
The current step the person is in, in the process
A list of all available steps in the process
A list of all available steps in the process
The objects returned when searching for different content. For example, the companies or products being compared with one another, or 2nd party intent
The name of the entity the person searched for
The type of the entity the person searched for
The domain of the entity
The ID of the entity in the partner system
The URL of the entity in the partner system
Include additional custom data about the content
Include additional custom data about the event
The name of the custom field
The value of the custom field
The data type of the custom field: NUMBER, STRING, DATE (ISO 8601), URL, DURATION (in Seconds). Default value: STRING
The person who did the event. Must be null if a tracking ID is sent instead.
The name of the person
The email address of the person. Used for business context association
The phone number of the person. Used for business context association
A unique person identifier in the partner system. Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty
The person's details in an external system such as the CRM
The object type in the external system
The ID of the object in the external system
The name of the external system
The location of the person as identified in the partner's source system
The country of the person in ISO 3166. If not available in ISO 3166, then send as string
The state of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string
The region of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string
The city of the person
The company the person works in. Should include at least one of the following: domain, crmAccountId, crmOpportunityId (via the companyBusinessContext object)
The company ID in the partner's source system
The name of the company
The domain of the person's company. Used to associate the person with the company ("acme.com"). Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty
The company's details in an external system such as the CRM. If the domain is empty, to enable association, send the crmAccountId or crmOpportunityId
The company's details in an external system such as the CRM. If the domain is empty, to enable association, send the crmAccountId or crmOpportunityId
The object type in the external system
The ID of the business context object
The name of the external system
Include additional custom data about the person
Include additional custom data about the event
The name of the custom field
The value of the custom field
The data type of the custom field: NUMBER, STRING, DATE (ISO 8601), URL, DURATION (in Seconds). Default value: STRING
Include additional custom data about the event
Include additional custom data about the event
The name of the custom field
The value of the custom field
The data type of the custom field: NUMBER, STRING, DATE (ISO 8601), URL, DURATION (in Seconds). Default value: STRING
The ID used for tracking the person who did the event. Must be null if a person is sent instead.
Successful response
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
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.