--- title: "Add a digital Interaction" slug: "post-a-digital-interaction-v2digital-interaction-1" 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. # Post a Digital Interaction (/v2/digital-interaction) Post/v2/digital-interaction Required authorizaton scope: 'api:digital-interactions:write'. Body parametersExpand Allobject Digital interaction metadata eventIdstring Required The provider's unique identifier for the event used for deduplication timestampstring (date-time) Required The date and time of the event in ISO 8601 format eventTypestring Required The type of the event, explaining the content and action performed. Values may be partner-aligned, for example, "link clicked", "page viewed" sourceSystemNamestring 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 sessionIdstring The identifier for the session, useful for tying related events together devicestring The device used during the event Valid values[ "MOBILE", "PC" ] contentobject (Content) Required The content the person looked at contentIdstring A unique identifier for the content in the partner's system contentTitlestring Required The title of the content contentLabel Array of string A list of tags defined for the content string A list of tags defined for the content contentUrlstring The URL for the content the person looked at contentAdditionalInfoUrlstring The URL for additional details provided by the website or external app, such as analysis of the content viewed numericContentDetailsobject (NumericContentDetails) For content where there is a numeric result, such as NPS score, or metrics such as the percentage of video watched valueinteger (int32) The numeric value for the content rangeFrominteger (int32) Required The lowest value that can be given to the content rangeTointeger (int32) Required The highest value that can be given to the content numericTypestring The type of numeric value Valid values[ "PERCENTAGE", "NPS", "RATING", "OTHER" ] stepContentDetailsobject (StepContentDetails) For content where there are a number of steps to complete in the content, such as shipment tracking or course advancement valuestring Required The current step the person is in, in the process availableSteps Array of string Required A list of all available steps in the process string A list of all available steps in the process searchObjectDetailsobject (SearchObjectDetails) The objects returned when searching for different content. For example, the companies or products being compared with one another, or 2nd party intent namestring Required The name of the entity the person searched for objectTypestring Required The type of the entity the person searched for Valid values[ "VENDOR", "PRODUCT", "CATEGORY" ] domainstring Required The domain of the entity objectIdstring The ID of the entity in the partner system urlstring The URL of the entity in the partner system contentCustomFields Array of object (CustomField) Include additional custom data about the content object Include additional custom data about the event namestring Required The name of the custom field valuestring Required The value of the custom field dataTypestring The data type of the custom field: NUMBER, STRING, DATE (ISO 8601), URL, DURATION (in Seconds). Default value: STRING Valid values[ "STRING", "NUMBER", "DATE", "URL", "BOOLEAN", "DURATION" ] personobject (Person) The person who did the event. Must be null if a tracking ID is sent instead. namestring The name of the person emailstring The email address of the person. Used for business context association phoneNumberstring The phone number of the person. Used for business context association personIdstring A unique person identifier in the partner system. Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty personBusinessContextobject (PersonBusinessContext) The person's details in an external system such as the CRM objectTypestring Required The object type in the external system Valid values[ "CONTACT", "LEAD" ] objectIdstring Required The ID of the object in the external system systemNamestring The name of the external system locationobject (Location) The location of the person as identified in the partner's source system countrystring The country of the person in ISO 3166. If not available in ISO 3166, then send as string statestring The state of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string regionstring The region of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string citystring The city of the person companyobject (Company) The company the person works in. Should include at least one of the following: domain, crmAccountId, crmOpportunityId (via the companyBusinessContext object) companyIdstring The company ID in the partner's source system namestring The name of the company domainstring 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 companyBusinessContexts Array of object (CompanyBusinessContext) 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 object 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 objectTypestring Required The object type in the external system Valid values[ "ACCOUNT", "OPPORTUNITY" ] objectIdstring Required The ID of the business context object systemNamestring The name of the external system personCustomFields Array of object (CustomField) Include additional custom data about the person object Include additional custom data about the event namestring Required The name of the custom field valuestring Required The value of the custom field dataTypestring The data type of the custom field: NUMBER, STRING, DATE (ISO 8601), URL, DURATION (in Seconds). Default value: STRING Valid values[ "STRING", "NUMBER", "DATE", "URL", "BOOLEAN", "DURATION" ] customFields Array of object (CustomField) Include additional custom data about the event object Include additional custom data about the event namestring Required The name of the custom field valuestring Required The value of the custom field dataTypestring The data type of the custom field: NUMBER, STRING, DATE (ISO 8601), URL, DURATION (in Seconds). Default value: STRING Valid values[ "STRING", "NUMBER", "DATE", "URL", "BOOLEAN", "DURATION" ] trackingIdstring The ID used for tracking the person who did the event. Must be null if a person is sent instead. Responses200 Successful response object requestIdstring A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. Example4al018gzaztcr8nbukw 400 Malformed request 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 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. 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. 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 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