Skip to main content
Gainsight Inc.

Integrate with Gainsight PX Using Webhooks

  1. Last updated
  2. Save as PDF

This article explains how to configure Webhook and integrate Gainsight PX with external web services to send notifications when an event occurs.

Overview

Configure Webhooks in Gainight PX to track events in an application and trigger predefined workflows in another application when an event occurs without the need for a function call or request.

Webhook, also  known as the web callback or HTTP push API, is an event-based mechanism that tracks, collects, and exports real-time information to the endpoint URL (third-party web services provider) using the HTTP request payload. The endpoint (callback) URL can be a platform, web server, or any other web resource that performs a predefined action depending on the workflow.

For example, you can track an engagement event for new users on the application and send email campaigns from the integrated marketing application. When a user logs in to the application for the first time and views the engagement, Gainsight PX tracks and event data to the callback URL you specified. The Webhook URL runs the workflow and the corresponding email marketing campaigns or surveys are triggered to the user accounts automatically.  

Gainsight PX allows you to configure outgoing Webhooks for the following events:

  • Feature match (key feature usage and behavior)
  • Engagement behavior
  • Survey results
  • Segment match 
  • Custom events
  • New User Created

Note: Gainsight PX sends a maximum of 10,000 Webhook events in a day for a subscription.

Advantages Of Using Webhooks

Following are a few advantages of using Webhooks compared to APIs:

  • Easy to implement and maintain. 
  • Automatically sends near real-time notifications to the endpoint URL without the need to trigger a function call.
  • Eliminates the need of sending repeated requests to external systems for new events.

Configure Webhook in Gainsight PX

To configure a Webhook:

  1. Navigate to Administration > Webhooks.
  2. On the Webhooks list page, click +New. The Webhook details page appears.
    Note: You can activate or deactivate an existing Webhook from the Enabled column on the list page.

webhook_new.png

  1. In the Webhook Details section, do the following: 
    • Enter the name of the Webhook.
    • From the Adapters dropdown menu, select the adapter applicable for your integration. The adapter varies with the event framework or integration service provider.
      Note: 
      • Some adapters are pre-configured and are available by default such as the CS Event Framework. For more information on how to configure the adapter for your integration service, contact the Gainsight PX support team. 
      • You can select Default in this field to do custom configurations.
    • Enter the tenant or subscription-specific endpoint URL, in the Callback URL field, to which you want Gainsight PX to export the event data. This URL is the listener for Webhook calls on the endpoint application. The Callback URL field is populated if you select the pre-configured Adapter. 
  2. Specify the Product, Channel, and Environment where you want to track the events.
  3. In the Headers section, click +Add to define the key-value pairs manually for the HTTP header of the outgoing request.
    Note: If you select the pre-configured Adapter, the header attributes are populated and you must specify the values.
  4. In the Content Type dropdown, select the format/structure for the data (payload) sent to the callback URL. Following options are available:
    • Flat JSON: The attributes and fields in the payload are not nested and separated by a dot (.). 
    • JSON: If selected, the attributes and fields in the payload are converted to a nested structure.
      Note: For sample Flat and Nested JSON payloads for the events, refer to the Understand Webhook Payloads section.​​​​​
  5. In the Trigger Events section, click the +Add option to add event types you want to track. PX supports the following events for Webhooks:
  • Custom 
  • Feature Match
  • Segment
  • Engagement (Dialog, Slider, Guide, and Survey)
  • New User
  • Feedback Event
  • Segment IO Cloud Server
  1. Click Save.

Understand Webhook Payloads

This section explains the objects and attributes/fields in the Webhook payload sent to the endpoint URL for the following Gainsight PX events.

  • Feature match 
  • Engagement 
  • Survey 
  • Segment match 
  • Custom event
  • New User

Gainsight PX Webhook payload comprises user, account and event objects. The JSON objects are represented in key/value pairs. Keys (attributes) and values are separated by a colon.

Notes:

  • Gainsight PX sends events as a batch with a maximum array size of 100.
  • Gainsight PX does NOT send any events generated by API to Webhook.

Following table lists the objects and their attributes in the payload.

Object JSON attribute (Nested) JSON attribute (Flat) Description

User

 aptrinsicId user.aptrinsicId  
type user.type  
identifyId user.identifyId  
gender user.gender  
email user.email  
firstName user.firstName  
lastName user.lastName  
createDate user.createDate  
lastModifiedDate user.lastModifiedDate  
lastSeenDate user.lastSeenDate  
signUpDate user.signUpDate  
firstVisitDate user.firstVisitDate  
title user.title  
phone user.phone  
score user.score  
accountId user.accountId  
numberOfVisits user.numberOfVisits  
sfdcContactId user.sfdcContactId  
customAttributes user.customAttributes  
location user.location  

Account

 id account.id  
name account.name  
sfdcId account.sfdcId  
lastSeenDate account.lastSeenDate  
dunsNumber account.dunsNumber  
industry account.industry  
numberOfEmployees account.numberOfEmployees  
sicCode account.sicCode  
website account.website  
naicsCode account.naicsCode  
plan account.plan  
createDate account.createDate  
lastModifiedDate account.lastModifiedDate  
numberOfVisits account.numberOfVisits  
numberOfUsers account.numberOfUsers  
inferredSfdcId account.inferredSfdcId  
customAttributes account.customAttributes  
location account.location  

Location

 countryCode location.countryCode  
countryName locatino.countryName  
stateCode location.stateCode  
stateName location.stateName  
cityName location.city  
continentCode location.continent  
postalCode location.postalCode  
coordinates.latitude location.coordinates.latitude  
coordinates.longitude location.coordinates.longitude  
regionName location.regionName  
timeZone location.timeZone  
street location.street  

Event

 eventId eventId  
date date Stores the timestamp in milliseconds (UTC format).
eventType eventType Indicates the type of event:
  • FEATURE_MATCH
  • SEGMENT
  • CUSTOM
  • SURVEY
  • ENGAGEMENT
propertyKey propertyKey Stores the ID of the product where the event occurred.
sessionId sessionId  
globalContext globalContext  

The event object also includes attributes that are specific to the event type. Following sections show you the event specific attributes and sample Flat and Nested JSON payloads when the event occurs.

Payload for Feature Match Event

When a feature match event occurs in the application, the following attributes are included in the JSON payload.

  • featureId
  • featureName
Flat JSON payload for Feature Match event
{
  "user.aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1601303023883,
  "user.signUpDate": 1601303023742,
  "user.firstVisitDate": 1601303023742,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 1,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0.0,
  "user.location.coordinates.longitude": 0.0,
  "user.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "user.createDate": 1601303023742,
  "user.lastModifiedDate": 1601303023911,
  "user.customAttributes.lang": "hi-IN",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1601303023883,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0.0,
  "account.location.coordinates.longitude": 0.0,
  "account.numberOfUsers": 0,
  "account.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "account.createDate": 1601303023742,
  "account.lastModifiedDate": 1601303023883,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "FEATURE_MATCH",
  "event.eventId": "377d1730-63fd-4a07-bfb1-aef12e483006-05951b40-944f-4052-9a4a-51c74683f658",
  "event.propertyKey": "AP-8MF5LPSWUBFW-2-1",
  "event.date": 1601305790659,
  "event.sessionId": "AP-8MF5LPSWUBFW-2-1601303023809-98881162",
  "event.globalContext.role": "Admin",
  "event.userType": "USER",
  "event.featureId": "05951b40-944f-4052-9a4a-51c74683f658",
  "event.featureName": "Charts"
}
Nested JSON payload for Feature Match event
{
  "user": {
    "aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1601303023883,
    "signUpDate": 1601303023742,
    "firstVisitDate": 1601303023742,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 1,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0.0,
        "longitude": 0.0
      }
    },
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023911,
    "customAttributes": {
      "lang": "hi-IN"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com"
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1601303023883,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0.0,
        "longitude": 0.0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023883,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "FEATURE_MATCH",
    "eventId": "ae1e5538-1736-4088-86d1-e90a10ffe901-05951b40-944f-4052-9a4a-51c74683f658",
    "propertyKey": "AP-8MF5LPSWUBFW-2-1",
    "date": 1601305595931,
    "sessionId": "AP-8MF5LPSWUBFW-2-1601303023809-98881162",
    "globalContext": {
        "role" : "Admin"      
    },
    "userType": "USER",
    "featureId": "05951b40-944f-4052-9a4a-51c74683f658",
    "featureName": "Charts"
  }
}

Payload for Engagement Event

When an engagement event occurs in the application, the following attributes are included in the JSON payload.

Attribute Description
contentType Indicates the type of engagement event. Possible values:
  • IN_APP_DIALOG
  • IN_APP_GUIDE
  • IN_APP_CAROUSEL
engagementType Indicates the type of engagement event. Possible values:
  • Slider
  • Dialog
  • Guide
engagementName Indicates the name of the engagement.
interaction Indicates the status of the event. Possible values:
  • COMPLETED
  • VIEWED
  • RESPONDED
  • CLICKED
  • VIEWED_STEP
stepNumber  
activation Indicates the trigger for the engagement event. Possible values:
  • Auto
  • Bot
  • Badge
  • Journey Orchestrator
executionId  
executionDate  
Flat JSON payload when user views the Dialog engagement
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605262502222,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 19,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605262502452,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "ENGAGEMENT",
  "event.eventId": "6494e73a-976b-4ee5-b8a8-de9effff7e80",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605262539389,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_DIALOG",
  "event.engagementId": "83c30d4e-88c3-4054-a0fa-33451a6ea7fc",
  "event.engagementType": "Dialog",
  "event.engagementName": "Release Announcement",
  "event.interaction": "VIEWED",
  "event.stepNumber": null,
  "event.activation": "Auto",
  "event.executionId": "b633945f-d4a5-404a-ae39-5ced5b542240",
  "event.executionDate": 1605262539389
}
Nested JSON payload when user views the Dialog engagement
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605262502222,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 19,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605262502452,
    "customAttributes": {
        "attribute1" : "value"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1605262502222,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1602080512395,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "ENGAGEMENT",
    "eventId": "6494e73a-976b-4ee5-b8a8-de9effff7e80",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605262539389,
    "sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_DIALOG",
    "engagementId": "83c30d4e-88c3-4054-a0fa-33451a6ea7fc",
    "engagementType": "Dialog",
    "engagementName": "Release Announcement",
    "interaction": "VIEWED",
    "stepNumber": null,
    "activation": "Auto",
    "executionId": "b633945f-d4a5-404a-ae39-5ced5b542240",
    "executionDate": 1605262539389
  }
}
Flat JSON payload when user views the Guide engagement
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605262502222,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 19,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605262502452,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "ENGAGEMENT",
  "event.eventId": "026eb832-360c-4ece-b7c7-bfb1510f98c6",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605263217968,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_GUIDE",
  "event.engagementId": "4743ccf0-34ef-48cb-9669-40058dc6059c",
  "event.engagementType": "Guide",
  "event.engagementName": "Guide Engagement",
  "event.interaction": "VIEWED",
  "event.stepNumber": null,
  "event.activation": "Auto",
  "event.executionId": "d3d38dd3-b540-4984-829d-550eeb96a36c",
  "event.executionDate": 1605263217968
}
Nested JSON payload when user views the Guide engagement
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605262502222,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 19,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605262502452,
    "customAttributes": {
        "attribute1" : "value"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1605262502222,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1602080512395,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "ENGAGEMENT",
    "eventId": "026eb832-360c-4ece-b7c7-bfb1510f98c6",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605263217968,
    "sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_GUIDE",
    "engagementId": "4743ccf0-34ef-48cb-9669-40058dc6059c",
    "engagementType": "Guide",
    "engagementName": "Guide Engagement",
    "interaction": "VIEWED",
    "stepNumber": null,
    "activation": "Auto",
    "executionId": "d3d38dd3-b540-4984-829d-550eeb96a36c",
    "executionDate": 1605263217968
  }
}
Flat JSON payload when user views a step in the Guide engagement
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605262502222,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 19,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605262502452,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "ENGAGEMENT",
  "event.eventId": "a1c499aa-7683-440f-83b1-29dc1d91d141",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605263217968,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_GUIDE",
  "event.engagementId": "4743ccf0-34ef-48cb-9669-40058dc6059c",
  "event.engagementType": "Guide",
  "event.engagementName": "Guide Engagement",
  "event.interaction": "STEP_VIEWED",
  "event.stepNumber": 0,
  "event.activation": "Auto",
  "event.executionId": "d3d38dd3-b540-4984-829d-550eeb96a36c",
  "event.executionDate": 1605263217968
}
Nested JSON payload when user views a step in the Guide engagement
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605262502222,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 19,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605262502452,
    "customAttributes": null,
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "",
    "name": "",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 0,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 0,
    "lastModifiedDate": 0,
    "customAttributes": null,
    "parentGroupId": ""
  },
  "event": {
    "eventType": "ENGAGEMENT",
    "eventId": "a1c499aa-7683-440f-83b1-29dc1d91d141",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605263217968,
    "sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
    "globalContext": {
      
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_GUIDE",
    "engagementId": "4743ccf0-34ef-48cb-9669-40058dc6059c",
    "engagementType": "Guide",
    "engagementName": "Guide Engagement",
    "interaction": "STEP_VIEWED",
    "stepNumber": 0,
    "activation": "Auto",
    "executionId": "d3d38dd3-b540-4984-829d-550eeb96a36c",
    "executionDate": 1605263217968
  }
}
Flat JSON payload when user completes the Guide engagement
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605262502222,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 19,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605262502452,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "ENGAGEMENT",
  "event.eventId": "71216762-17a9-4644-a346-61fb95b5ceb0",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605263230476,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_GUIDE",
  "event.engagementId": "4743ccf0-34ef-48cb-9669-40058dc6059c",
  "event.engagementType": "Guide",
  "event.engagementName": "Guide Engagement",
  "event.interaction": "COMPLETED",
  "event.stepNumber": null,
  "event.activation": "Auto",
  "event.executionId": "d3d38dd3-b540-4984-829d-550eeb96a36c",
  "event.executionDate": 1605263217968
}
Nested JSON payload when user completes the Guide engagement
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605262502222,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 19,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605262502452,
    "customAttributes": null,
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "",
    "name": "",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 0,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 0,
    "lastModifiedDate": 0,
    "customAttributes": null,
    "parentGroupId": ""
  },
  "event": {
    "eventType": "ENGAGEMENT",
    "eventId": "71216762-17a9-4644-a346-61fb95b5ceb0",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605263230476,
    "sessionId": "AP-N6SV00EVMR1E-2-1605262502068-24197555",
    "globalContext": {
      
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_GUIDE",
    "engagementId": "4743ccf0-34ef-48cb-9669-40058dc6059c",
    "engagementType": "Guide",
    "engagementName": "Guide Engagement",
    "interaction": "COMPLETED",
    "stepNumber": null,
    "activation": "Auto",
    "executionId": "d3d38dd3-b540-4984-829d-550eeb96a36c",
    "executionDate": 1605263217968
  }
}
Flat JSON payload when user views a step in the Slider engagement
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605263800271,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 20,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605263800302,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "ENGAGEMENT",
  "event.eventId": "d8ea2a48-0800-44e3-b59f-9cf6a24aa812",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605263802822,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_CAROUSEL",
  "event.engagementId": "09f8b6e5-cc77-43fc-9a5c-787512ff9e55",
  "event.engagementType": "Slider",
  "event.engagementName": "Slider Engagement",
  "event.interaction": "STEP_VIEWED",
  "event.stepNumber": 1,
  "event.activation": "Auto",
  "event.executionId": "4906559f-b7a2-460b-92a8-ad86dd730f70",
  "event.executionDate": 1605263800615
}
Nested JSON payload when user views a step in the Slider engagement
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605263800271,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 20,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605263800302,
    "customAttributes": {
        "attribute1" : "value"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1605263800271,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1602080512395,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "ENGAGEMENT",
    "eventId": "d8ea2a48-0800-44e3-b59f-9cf6a24aa812",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605263802822,
    "sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_CAROUSEL",
    "engagementId": "09f8b6e5-cc77-43fc-9a5c-787512ff9e55",
    "engagementType": "Slider",
    "engagementName": "Slider Engagement",
    "interaction": "STEP_VIEWED",
    "stepNumber": 1,
    "activation": "Auto",
    "executionId": "4906559f-b7a2-460b-92a8-ad86dd730f70",
    "executionDate": 1605263800615
  }
}

Payload for Survey Event

When a survey event occurs in the application, the following attributes are included in the JSON payload.

Attribute Description
contentType Indicates the type of survey event. Possible values:
  • IN_APP_SURVEY_NPS
  • IN_APP_SURVEY_CES
  • IN_APP_SURVEY_BOOLEAN
  • IN_APP_SURVEY_RATING
  • IN_APP_MULTIPLE_QUESTION_SURVEY
engagementId  
engagementName Indicates the name of the survey engagement.
surveyType Indicates the type of survey event. Possible values:
  • NPS
  • CES
  • Rating
  • Boolean
  • Multi Question
interaction Indicates the status of the event. Possible values:
  • Completed
  • Viewed
  • Responded
  • Clicked
score  
scoreType Indicates the user category based on response to the survey. Possible values:
  • PROMOTER
  • PASSIVE
  • DETRACTOR
stepNumber  
userInput Indicates whether the user provided has feedback/suggestions and comments during the survey.
activation Indicates the trigger for the survey event. Possible values:
  • Auto
  • Bot
  • Badge
  • Journey Orchestrator
executionId  
executionDate  
questionType Indicates the question type included in the survey. Possible values:
  • Score
  • Multi choice
  • Open Text question
contactMeAllowed Indicates the status of the contact me response in the survey.  Possible values:
  • null- This value is populated when the “contact me” field is not enabled for the survey
  • true- This value indicates that the user has responded to the survey by checking the “contact me” field 
  • false- This value indicates that the user has not checked the “contact me” field when responding the survey

Note: The “contact me” field is only populated when the status of the “interaction” field is “COMPLETED".
.Flat JSON payload when user responds to single step in the Multi Question Survey
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605265939935,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 21,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605265939964,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.id": "johh.doe@gmail.com",
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1605265939935,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.propertyKeys": [
    
  ],
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "SURVEY",
  "event.eventId": "c9883e3b-05d4-4f96-8b9c-e2ce10430493",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605265950157,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605265939566-23853426",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_MULTIPLE_QUESTION_SURVEY",
  "event.engagementId": "e5362226-75da-4ef6-999a-823727e3d7a7",
  "event.engagementName": "Quarterly  Survey",
  "event.surveyType": "Multi Question",
  "event.interaction": "SINGLE_STEP_SURVEY_RESPONDED",
  "event.score": 0,
  "event.activation": "Auto",
  "event.executionId": "1ad2d383-d1fa-425d-84f0-2a531e17a5d9",
  "event.executionDate": 1605265939965,
  "event.questionType": "Multi choice",
  "event.questionId": "de9e6bf1-351c-46ec-907d-c985bd420c2b",
  "event.questionHtml": "<div class=px-multi-survey-question>Favorite travel destinations</div>",
  "event.questionText": "Favorite travel destinations",
  "event.answers[0].answerId": "563e2103-2906-4088-869f-bcccd185f288",
  "event.answers[0].answerHtml": "<div class=px-multi-survey-answer>Europe</div>",
  "event.answers[0].answerText": "Europe"
}
Nested JSON payload when user responds to single step in the Multi Question Survey 
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605265939935,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 21,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605265939964,
    "customAttributes": {
        "attribute1" : "value"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1605265939935,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1602080512395,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "SURVEY",
    "eventId": "c9883e3b-05d4-4f96-8b9c-e2ce10430493",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605265950157,
    "sessionId": "AP-N6SV00EVMR1E-2-1605265939566-23853426",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_MULTIPLE_QUESTION_SURVEY",
    "engagementId": "e5362226-75da-4ef6-999a-823727e3d7a7",
    "engagementName": "Quarterly  Survey",
    "surveyType": "Multi Question",
    "interaction": "SINGLE_STEP_SURVEY_RESPONDED",
    "score": 0,
    "activation": "Auto",
    "executionId": "1ad2d383-d1fa-425d-84f0-2a531e17a5d9",
    "executionDate": 1605265939965,
    "questionType": "Multi choice",
    "questionId": "de9e6bf1-351c-46ec-907d-c985bd420c2b",
    "questionHtml": "<div class=px-multi-survey-question>Favorite travel destinations</div>",
    "questionText": "Favorite travel destinations",
    "answers": [
        {
        "answerId": "563e2103-2906-4088-869f-bcccd185f288",
        "answerHtml": "<div class=px-multi-survey-answer>Europe</div>",
        "answerText": "Europe"
        }
    ]
  }
}
Flat JSON payload when user views the NPS Survey
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605263800271,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 20,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605263800302,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "SURVEY",
  "event.eventId": "91fc7270-9726-447c-95b1-b2183de05419",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605264056441,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_SURVEY_NPS",
  "event.engagementId": "41146d9c-79cb-4642-a3bc-9ed367a94dd3",
  "event.engagementName": "NPS Survey",
  "event.surveyType": "NPS",
  "event.interaction": "VIEWED",
  "event.score": null,
  "event.scoreType": null,
  "event.stepNumber": null,
  "event.userInput": null,
  "event.activation": "Auto",
  "event.executionId": "8ca14f80-2dde-4346-a6e3-4efe1ada9ca4",
  "event.executionDate": 1605264056441
}
Nested JSON payload when user views the NPS Survey 
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605263800271,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 20,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605263800302,
    "customAttributes": {
        "attribute1" : "value"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1605263800271,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1602080512395,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "SURVEY",
    "eventId": "91fc7270-9726-447c-95b1-b2183de05419",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605264056441,
    "sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_SURVEY_NPS",
    "engagementId": "41146d9c-79cb-4642-a3bc-9ed367a94dd3",
    "engagementName": "NPS Survey",
    "surveyType": "NPS",
    "interaction": "VIEWED",
    "score": null,
    "scoreType": null,
    "stepNumber": null,
    "userInput": null,
    "activation": "Auto",
    "executionId": "8ca14f80-2dde-4346-a6e3-4efe1ada9ca4",
    "executionDate": 1605264056441
  }
}
Flat JSON payload when user responds to single step in the NPS Survey
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605263800271,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 20,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605263800302,
  "user.customAttributes.test": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "SURVEY",
  "event.eventId": "3eae0d73-e9bc-4ac3-84e3-3c24dc3adcf9",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605264077032,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_SURVEY_NPS",
  "event.engagementId": "41146d9c-79cb-4642-a3bc-9ed367a94dd3",
  "event.engagementName": "NPS Survey",
  "event.surveyType": "NPS",
  "event.interaction": "SINGLE_STEP_SURVEY_RESPONDED",
  "event.score": 10,
  "event.scoreType": "PROMOTER",
  "event.stepNumber": null,
  "event.userInput": "I like the new product features",
  "event.activation": "Auto",
  "event.executionId": "8ca14f80-2dde-4346-a6e3-4efe1ada9ca4",
  "event.executionDate": 1605264056441,
  "event.questionHtml": "<div class=\"px-survey-title\">\n<div>\nHow do you like our new features?\n</div>\n</div>\n",
  "event.questionText": "How do you like our new features?"
}
Nested JSON payload when user responds to single step in the NPS Survey
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605263800271,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 20,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605263800302,
    "customAttributes": {
        "attribute1" : "value"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1605263800271,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1602080512395,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "SURVEY",
    "eventId": "3eae0d73-e9bc-4ac3-84e3-3c24dc3adcf9",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605264077032,
    "sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_SURVEY_NPS",
    "engagementId": "41146d9c-79cb-4642-a3bc-9ed367a94dd3",
    "engagementName": "NPS Survey",
    "surveyType": "NPS",
    "interaction": "SINGLE_STEP_SURVEY_RESPONDED",
    "score": 10,
    "scoreType": "PROMOTER",
    "stepNumber": null,
    "userInput": "I like the new product features",
    "activation": "Auto",
    "executionId": "8ca14f80-2dde-4346-a6e3-4efe1ada9ca4",
    "executionDate": 1605264056441,
    "questionHtml": "<div class=\"px-survey-title\">\n<div>\nHow do you like our new features?\n</div>\n</div>\n",
    "questionText": "How do you like our new features?"
  }
}
Flat JSON payload when user responds to single step (Open text question) in the NPS Survey
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605265939935,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 21,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605265939964,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.id": "johh.doe@gmail.com",
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1605265939935,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.propertyKeys": [
    
  ],
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "SURVEY",
  "event.eventId": "c9883e3b-05d4-4f96-8b9c-e2ce10430493",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605265950157,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605265939566-23853426",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_MULTIPLE_QUESTION_SURVEY",
  "event.engagementId": "e5362226-75da-4ef6-999a-823727e3d7a7",
  "event.engagementName": "Quarterly  Survey",
  "event.surveyType": "Multi Question",
  "event.interaction": "SINGLE_STEP_SURVEY_RESPONDED",
  "event.score": 0,
  "event.activation": "Auto",
  "event.executionId": "1ad2d383-d1fa-425d-84f0-2a531e17a5d9",
  "event.executionDate": 1605265939965,
  "event.questionType": "Open text question",
  "event.questionId": "de9e6bf1-351c-46ec-907d-c985bd420c2b",
  "event.questionHtml": "<div class=\"px-survey-title\">\n    <div>\n        Do you have any other comments?\n     </div>\n</div>\n",
  "event.questionText": "Do you have any other comments?",
  "event.userInput": "user comments goes here"
}
Nested JSON payload when user responds to single step (Open text question) in the NPS Survey 
{
  "user": {
    "aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1605265939935,
    "signUpDate": 1602080512396,
    "firstVisitDate": 1602080512396,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 21,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-N6SV00EVMR1E-2-1"
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1605265939964,
    "customAttributes": {
        "attribute1" : "value"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com",
    "lastInferredLocation": null
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1605265939935,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      
    ],
    "createDate": 1602080512395,
    "lastModifiedDate": 1602080512395,
    "customAttributes": {
        "attribute1" : "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "SURVEY",
    "eventId": "c9883e3b-05d4-4f96-8b9c-e2ce10430493",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605265950157,
    "sessionId": "AP-N6SV00EVMR1E-2-1605265939566-23853426",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "EMPTY_USER_TYPE",
    "contentType": "IN_APP_MULTIPLE_QUESTION_SURVEY",
    "engagementId": "e5362226-75da-4ef6-999a-823727e3d7a7",
    "engagementName": "Quarterly  Survey",
    "surveyType": "Multi Question",
    "interaction": "SINGLE_STEP_SURVEY_RESPONDED",
    "score": 0,
    "scoreType": null,
    "stepNumber": null,
    "userInput": "I like new features",
    "activation": "Auto",
    "executionId": "1ad2d383-d1fa-425d-84f0-2a531e17a5d9",
    "executionDate": 1605265939965,
    "questionType": "Open text question",
    "questionHtml": "<div class=\"px-survey-title\">\n    <div>\n        How was your experience?\n     </div>\n</div>\n",
    "questionText": "How was your experience?"
  }
}
Flat JSON payload when user completes the NPS Survey
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605263800271,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 20,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605263800302,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "SURVEY",
  "event.eventId": "79afb049-9b9c-429b-9626-e5bf5e010fbf",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605264077032,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_SURVEY_NPS",
  "event.engagementId": "41146d9c-79cb-4642-a3bc-9ed367a94dd3",
  "event.engagementName": "NPS Survey",
  "event.surveyType": "NPS",
  "event.interaction": "COMPLETED",
  "event.score": null,
  "event.scoreType": null,
  "event.stepNumber": null,
  "event.userInput": null,
  "event.activation": "Auto",
  "event.executionId": "8ca14f80-2dde-4346-a6e3-4efe1ada9ca4",
  "event.executionDate": 1605264056441
}
Nested JSON payload when user completes the NPS Survey
{
  "user.aptrinsicId": "65d01155-e652-49f7-b9f3-8bc7bdb01e2d",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1605263800271,
  "user.signUpDate": 1602080512396,
  "user.firstVisitDate": 1602080512396,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 20,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-N6SV00EVMR1E-2-1",
  "user.createDate": 1602080512395,
  "user.lastModifiedDate": 1605263800302,
  "user.customAttributes.attribute1": "value",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "user.lastInferredLocation": null,
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1602080512395,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.createDate": 1602080512395,
  "account.lastModifiedDate": 1602080512395,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "SURVEY",
  "event.eventId": "79afb049-9b9c-429b-9626-e5bf5e010fbf",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605264077032,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605263799879-28344454",
  "event.globalContext.role": "Admin",
  "event.userType": "EMPTY_USER_TYPE",
  "event.contentType": "IN_APP_SURVEY_NPS",
  "event.engagementId": "41146d9c-79cb-4642-a3bc-9ed367a94dd3",
  "event.engagementName": "NPS Survey",
  "event.surveyType": "NPS",
  "event.interaction": "COMPLETED",
  "event.score": null,
  "event.scoreType": null,
  "event.stepNumber": null,
  "event.userInput": null,
  "event.activation": "Auto",
  "event.executionId": "8ca14f80-2dde-4346-a6e3-4efe1ada9ca4",
  "event.executionDate": 1605264056441
}

Payload for Segment Match Event

When the segment match occurs in the application, the following attributes are included in the JSON payload.

  • segmentId
  • segmentName
Flat JSON payload for Segment Match
{
  "user.aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1601303023883,
  "user.signUpDate": 1601303023742,
  "user.firstVisitDate": 1601303023742,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 1,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0.0,
  "user.location.coordinates.longitude": 0.0,
  "user.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "user.createDate": 1601303023742,
  "user.lastModifiedDate": 1601303023911,
  "user.customAttributes.lang": "hi-IN",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1601305901457,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0.0,
  "account.location.coordinates.longitude": 0.0,
  "account.numberOfUsers": 0,
  "account.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "account.createDate": 1601303023742,
  "account.lastModifiedDate": 1601305901457,
  "account.customAttributes": null,
  "account.parentGroupId": "",
  "event.eventType": "SEGMENT",
  "event.eventId": "623b8a2d-e1c7-49cc-aa0a-fe53ec4b295f",
  "event.propertyKey": "AP-8MF5LPSWUBFW-2-1",
  "event.date": 1601305901390,
  "event.sessionId": "AP-8MF5LPSWUBFW-2-1601305901341-51431252",
  "event.globalContext.role": "Admin",
  "event.userType": "USER",
  "event.segmentId": "e3ab2e48-24f9-4602-ab92-b9f1f4343845",
  "event.segmentName": "Linux User"
}
Nested JSON payload for Segment Match
{
  "user": {
    "aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1601303023883,
    "signUpDate": 1601303023742,
    "firstVisitDate": 1601303023742,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 1,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0.0,
        "longitude": 0.0
      }
    },
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023911,
    "customAttributes": {
      "lang": "hi-IN"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com"
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1601303023883,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0.0,
        "longitude": 0.0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023883,
    "customAttributes": {
      "attribute1": "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "SEGMENT",
    "eventId": "ddb9ca94-beb1-449c-bdcd-b53190f8e784",
    "propertyKey": "AP-8MF5LPSWUBFW-2-1",
    "date": 1601303075964,
    "sessionId": "AP-8MF5LPSWUBFW-2-1601303023809-98881162",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "USER",
    "segmentId": "e3ab2e48-24f9-4602-ab92-b9f1f4343845",
    "segmentName": "Linux User"
  }
}

Payload for Custom Event

When a custom event occurs in the application, the following attributes are included in the JSON payload.

  • eventName
  • attributes
  • url
  • referrer
  • remoteHost
Flat JSON payload for Custom event
{
  "user.aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1601303023883,
  "user.signUpDate": 1601303023742,
  "user.firstVisitDate": 1601303023742,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 1,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0.0,
  "user.location.coordinates.longitude": 0.0,
  "user.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "user.createDate": 1601303023742,
  "user.lastModifiedDate": 1601303023911,
  "user.customAttributes.lang": "hi-IN",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1601303023883,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0.0,
  "account.location.coordinates.longitude": 0.0,
  "account.numberOfUsers": 0,
  "account.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "account.createDate": 1601303023742,
  "account.lastModifiedDate": 1601303023883,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": "",
  "event.eventType": "CUSTOM",
  "event.eventId": "0d92b461-c158-4c26-80cc-09bcc5f786c3",
  "event.propertyKey": "AP-8MF5LPSWUBFW-2-1",
  "event.date": 1601305847130,
  "event.sessionId": "AP-8MF5LPSWUBFW-2-1601303023809-98881162",
  "event.globalContext.role": "Admin",
  "event.userType": "USER",
  "event.eventName": "webhook-test",
  "event.attributes.Category": "Admin",
  "event.attributes.terms": "profile setting how-to",
  "event.attributes.results": 10.0,
  "event.url": "http://localhost:4201/charts",
  "event.referrer": "null",
  "event.remoteHost": "127.0.0.1"
}
Nested JSON payload for Custom event
{
  "user": {
    "aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1601303023883,
    "signUpDate": 1601303023742,
    "firstVisitDate": 1601303023742,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 1,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0.0,
        "longitude": 0.0
      }
    },
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023911,
    "customAttributes": {
      "lang": "hi-IN"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com"
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1601303023883,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0.0,
        "longitude": 0.0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023883,
    "customAttributes": {
      "attribute1": "value"
    },
    "parentGroupId": ""
  },
  "event": {
    "eventType": "CUSTOM",
    "eventId": "16a48fd6-484a-4dca-9135-210da8b6b6b2",
    "propertyKey": "AP-8MF5LPSWUBFW-2-1",
    "date": 1601305716123,
    "sessionId": "AP-8MF5LPSWUBFW-2-1601303023809-98881162",
    "globalContext": {
        "role" : "Admin"
    },
    "userType": "USER",
    "eventName": "webhook-test",
    "attributes": {
      "Category": "Admin",
      "terms": "profile setting how-to",
      "results": 10.0
    },
    "url": "http://localhost:4201/charts",
    "referrer": "null",
    "remoteHost": "127.0.0.1"
  }
}

Payload for New User Event

Gainsight PX tracks new user subscriptions in the application and sends data to the integrated application only if the identify() call received from your application includes the ‘signupDate’ attribute and if the user has subscribed within the last one hour. 

Note: If the identify() call does not contain the sign up date (in milliseconds), Gainsight PX considers the timestamp of the identify event as sign up date of the user.

For more information on how your Gainsight PX subscription tracks your users and accounts, refer to the Track your Users and Accounts article from the Additional Resources section

Following is the sample JSON payload that is sent to the external system when the New User event occurs in the application.

Flat JSON payload for New User event
{
  "event.eventType": "SIGN_UP",
  "event.eventId": "46bbf3ef-225e-4c61-a72c-e1f21b3a07e6",
  "event.propertyKey": "AP-N6SV00EVMR1E-2-1",
  "event.date": 1605772883602,
  "event.sessionId": "AP-N6SV00EVMR1E-2-1605772883530-56633934",
  "event.globalContext.role": "Admin",
  "event.userType": "USER",
  "user.aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
  "user.identifyId": "johh.doe@gmail.com",
  "user.type": "USER",
  "user.gender": "EMPTY_GENDER",
  "user.email": "john.doe@gmail.com",
  "user.firstName": "John",
  "user.lastName": "Doe",
  "user.lastSeenDate": 1601303023883,
  "user.signUpDate": 1601303023742,
  "user.firstVisitDate": 1601303023742,
  "user.title": "",
  "user.phone": "",
  "user.score": 0,
  "user.role": "",
  "user.subscriptionId": "",
  "user.accountId": "Acme",
  "user.numberOfVisits": 1,
  "user.location.countryName": "",
  "user.location.countryCode": "",
  "user.location.stateName": "",
  "user.location.stateCode": "",
  "user.location.city": "",
  "user.location.street": "",
  "user.location.postalCode": "",
  "user.location.continent": "",
  "user.location.regionName": "",
  "user.location.timeZone": "",
  "user.location.coordinates.latitude": 0,
  "user.location.coordinates.longitude": 0,
  "user.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "user.createDate": 1601303023742,
  "user.lastModifiedDate": 1601303023911,
  "user.customAttributes.lang": "hi-IN",
  "user.globalUnsubscribe": false,
  "user.sfdcContactId": "",
  "user.lastVisitedUserAgentData": null,
  "user.id": "johh.doe@gmail.com",
  "account.id": "Acme",
  "account.name": "Acme",
  "account.trackedSubscriptionId": "",
  "account.sfdcId": "",
  "account.lastSeenDate": 1601303023883,
  "account.dunsNumber": "",
  "account.industry": "",
  "account.numberOfEmployees": 0,
  "account.sicCode": "",
  "account.website": "",
  "account.naicsCode": "",
  "account.plan": "",
  "account.location.countryName": "",
  "account.location.countryCode": "",
  "account.location.stateName": "",
  "account.location.stateCode": "",
  "account.location.city": "",
  "account.location.street": "",
  "account.location.postalCode": "",
  "account.location.continent": "",
  "account.location.regionName": "",
  "account.location.timeZone": "",
  "account.location.coordinates.latitude": 0,
  "account.location.coordinates.longitude": 0,
  "account.numberOfUsers": 0,
  "account.propertyKeys[0]": "AP-8MF5LPSWUBFW-2-1",
  "account.createDate": 1601303023742,
  "account.lastModifiedDate": 1601303023883,
  "account.customAttributes.attribute1": "value",
  "account.parentGroupId": ""
}
Nested JSON payload for New User event
{
  "event": {
    "eventType": "SIGN_UP",
    "eventId": "46bbf3ef-225e-4c61-a72c-e1f21b3a07e6",
    "propertyKey": "AP-N6SV00EVMR1E-2-1",
    "date": 1605772883602,
    "sessionId": "AP-N6SV00EVMR1E-2-1605772883530-56633934",
    "globalContext": {
      "role": "Admin"
    },
    "userType": "USER"
  },
  "user": {
    "aptrinsicId": "1b29cbb2-8e73-44e2-86fd-6472837285cd",
    "identifyId": "johh.doe@gmail.com",
    "type": "USER",
    "gender": "EMPTY_GENDER",
    "email": "john.doe@gmail.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastSeenDate": 1601303023883,
    "signUpDate": 1601303023742,
    "firstVisitDate": 1601303023742,
    "title": "",
    "phone": "",
    "score": 0,
    "role": "",
    "subscriptionId": "",
    "accountId": "Acme",
    "numberOfVisits": 1,
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023911,
    "customAttributes": {
      "lang": "hi-IN"
    },
    "globalUnsubscribe": false,
    "sfdcContactId": "",
    "lastVisitedUserAgentData": null,
    "id": "johh.doe@gmail.com"
  },
  "account": {
    "id": "Acme",
    "name": "Acme",
    "trackedSubscriptionId": "",
    "sfdcId": "",
    "lastSeenDate": 1601303023883,
    "dunsNumber": "",
    "industry": "",
    "numberOfEmployees": 0,
    "sicCode": "",
    "website": "",
    "naicsCode": "",
    "plan": "",
    "location": {
      "countryName": "",
      "countryCode": "",
      "stateName": "",
      "stateCode": "",
      "city": "",
      "street": "",
      "postalCode": "",
      "continent": "",
      "regionName": "",
      "timeZone": "",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    },
    "numberOfUsers": 0,
    "propertyKeys": [
      "AP-8MF5LPSWUBFW-2-1"
    ],
    "createDate": 1601303023742,
    "lastModifiedDate": 1601303023883,
    "customAttributes": {
      "attribute1": "value"
    },
    "parentGroupId": ""
  }
}

Payload for Feedback Event

"event": {
    "eventType": "FEEDBACK",
    "eventId": "d007bd76-decb-4a77-8456-d84fb15c6a83",
    "propertyKey": "AP-E9VUBBLZ6BIS-2-1",
    "date": 1665415753621,
    "sessionId": "AP-E9VUBBLZ6BIS-2-1665415678379-45445457",
    "globalContext": null,
    "userType": "USER",
    "subject": "feedback title",
    "category": "Labels test",
    "description": "feedback body",
    "labels": [
      "492120f5-3573-11ec-bef0-42010a800545"
    ],
    "source": "Knowledge Center Bot"
  }

Payload for Segment IO Cloud Server


"event": {
    "eventType": "SEGMENT_IO",
    "eventId": "testmessageid",
    "propertyKey": "AP-E9VUBBLZ6BIS-2-1",
    "date": 1665407461000,
    "sessionId": "eb7bcc30-81f6-4545-b795-254ca885817f",
    "globalContext": {},
    "userType": "USER",
    "segmentIOEvent": {
      "pxPropertyKey": "AP-E9VUBBLZ6BIS-2",
      "type": "identify",
      "userId": "user12345test",
      "context": {
        "ip": "24.5.68.47"
      },
      "messageId": "testmessageid",
      "timestamp": "2022-10-10T13:11:01Z",
      "traits": {
        "address": {
          "city": "Bila Tzerkva",
          "country": "UKraine",
          "postalCode": "09108",
          "state": "BC",
          "street": "Nekrasova"
        },
        "age": 24,
        "avatar": "",
        "email": "user12345test",
        "firstName": "abc",
        "lastName": "def",
        "gender": "female",
        "phone": "+382525252525252",
        "title": "Job Title",
        "website": ""
      }
    }
  },
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    Topic
  2. Tags
    1. create webhook
    2. PX webhook
    3. webhook integration
    4. webooks