Additional details about this Ticket.\nYou can set the details object either when creating a ticket or when updating an existing ticket.
"details": {
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
"iPAddress": "218.255.205.226",
"location": "Hartford, Vermont",
"cardsPath": "Main/Destination/Name/Mail address/Thanks",
"source": {
"title": "Glassix",
"uri": null
},
"externalLink": null,
"isMobile": false,
"identityTokenClaims": null,
"referral": {
"utmParameters": null,
"adId": "",
"adTitle": "",
"refData": "",
"productId": "",
"fbPostId": "",
"instagramStoryId": "",
"instagramStoryMediaUrl": null,
"appleIntentId": "",
"appleGroupId": "",
"twitterRootTweetId": "",
"whatsappHeadline": "",
"whatsappBody": "",
"whatsappSourceType": "",
"whatsappSourceId": "",
"whatsappSourceUrl": null
}
}
| Parameter | Type | Description |
|---|---|---|
| userAgent | string | The user agent of the customer. |
| iPAddress | string | The IP of the customer. |
| location | string | City, State, Country etc. |
| source | object | The source from which this ticket was opened. Can be a website address, a Facebook page, etc. |
| title | string | A part of source. |
| uri | string | A part of source. |
| externalLink | string | Link to the CRM ticket or another link you want the agent to see with the ticket details |
| identityTokenClaims | object | |
| myCustomClaim1 | string | A part of identityTokenClaims. |
| myCustomClaim | string | A part of identityTokenClaims. |
| referral | object | |
| utmParameters | object | A Part of referral. UTM parameters are just short pieces of code (starts with utm_) you can add to links. They include information about the link’s placement and purpose, making it easier to track clicks and traffic. This is relevent for the Web Chat channel. |
| utm_source | A part of utmParameters. | |
| utm_medium | A part of utmParameters. | |
| utm_campaign | A part of utmParameters. | |
| utm_content | A part of utmParameters. | |
| utm_term | A part of utmParameters. | |
| adId | string | A part of referral. Facebook ad/Instagram ad id that this ticket originated from. |
| adTitle | string | A part of referral. Facebook ad/Instagram ad title that this ticket originated from |
| refData | string | A part of referral. Data passed as a query string to messenger links. http:// m.me/<PAGE_NAME>?ref=<REF_PARAM> https://developers.facebook.com/docs/messenger-platform/discovery/m-me-links |
| productId | string | A part of referral. Product ID from the Ad the user is interested in |
| fbPostId | string | A part of referral. The FB post id. This can be sent via FB Comments or Messenger. |
| instagramStoryId | string | A part of referral. The IG sory id. |
| instagramStoryMediaUrl | string | A part of referral. The IG story media link. |
| appleIntentId | string | A part of referral. The Apple intent id. |
| appleGroupId | string | A part of referral. The Apple group id. |
| twitterRootTweetId | string | A part of referral. The Twitter root tweet id. |
| whatsappHeadline | string | A part of referral. Headline used in the ad that generated the message. |
| whatsappBody | string | A part of referral. Body from the ad that generated the message. |
| whatsappSourceType | string | A part of referral. The type of the ad’s source. Currently, supported values are ad and post. |
| whatsappSourceId | string | A part of referral. Facebook ID for an ad or a post sent via WhatsApp |
| whatsappSourceUrl | string | A part of referral. The url that leads to the ad or post. Opening this url takes you to the ad viewed by your user. |
| isMobile | boolean | Was this Ticket opened on the mobile? This value is valid only for chat tickets. |
Read more about WhatsApp refferals here.