livesend-summary-v2

Livesend engagement summary (deprecated)

Webhook Payload

The webhook event is encapsulated within a common wrapper structure providing general information about the event.

Property	Type	Description
application	string	The type of application, e.g., Web.
data	object	Data data object details
id	string	Unique identifier for the data.
version	string	Version of the data.
occurredAt	string	Timestamp when the event occurred.
tenantId	string	Unique identifier for the tenant.
tenantName	string	Name of the tenant.
productArea	string	product Area

data object details

Property	Type	Description
clientDetails	object	Details about the client. clientDetails object details
livesendSummary	object	Summary of the livesend session. livesendSummary object details

clientDetails object details

Property	Type	Description
sessionId	string	Unique identifier for the session.
ipAddress	string	IP address of the client.
productArea	string	Product area being used.
deviceType	string	Type of device used by the client.
browser	string	Browser used by the client.
browserVersion	string	Version of the browser used.
operatingSystem	string	Operating system of the client.
operatingSystemVersion	string	Version of the operating system.
locale	['string', 'null']	Locale settings of the client.
city	string	City of the client.
country	string	Country of the client.
applicationType	string	Type of application being used.
application	string	Name of the application.

livesendSummary object details

Property	Type	Description
sentBy	string	Identifier of the user who sent the livesend.
livesendLinkId	string	Identifier for the livesend link.
deliveryIntegratorContext	['string', 'null']	Context for the delivery integrator.
linkMembers	array of objects	List of members associated with the link. linkMembers array object details
livesendViewingSessionId	string	Identifier for the livesend viewing session.
sessionStartedAt	string	Timestamp when the session started.
sessionEndedAt	string	Timestamp when the session ended.
totalContent	integer	Total number of content items.
totalContentViewed	integer	Total number of content items viewed.
totalContentDownloaded	integer	Total number of content items downloaded.
totalDurationSeconds	integer	Total duration of the session in seconds.
detailsUrl	string	URL for the session details.
livesendUrl	string	URL for the livesend.
linkParameters	string	Parameters associated with the link.
notificationSetting	string	Notification setting for the livesend.
downloadFormatsSetting	string	Download formats setting for the livesend.
summaryByContent	array of objects	Summary of the content in the livesend. summaryByContent array object details

linkMembers array object details

Property	Type	Description
email	string	Email of the link member.
externalUserId	string	External user identifier for the link member.

summaryByContent array object details

Property	Type	Description
content	object	Details of the content. content object details
pages	integer	Number of pages in the content.
pagesViewed	integer	Number of pages viewed.
durationSeconds	integer	Duration of viewing in seconds.
wasDownloaded	boolean	Indicates if the content was downloaded.
downloadFormats	array	Formats in which the content was downloaded.
wasViewed	boolean	Indicates if the content was viewed.
summaryByPage	array of objects	Summary of the content by page. summaryByPage array object details

content object details

Property	Type	Description
repository	string	Repository of the content.
versionId	string	Version identifier of the content.
quickAccessPath	['string', 'null']	Quick access path for the content.
name	string	Name of the content.
id	string	Identifier of the content.
type	string	Type of the content.
pages	['string', 'null']	Number of pages in the content.

summaryByPage array object details

Property	Type	Description
pageIndex	integer	Index of the page.
thumbnailImageUrl	['string', 'null']	URL of the thumbnail image for the page.
durationMilliseconds	integer	Duration of viewing the page in milliseconds.

Example

{
  "application": "Web",
  "data": {
    "clientDetails": {
      "sessionId": "110061e5-5020-4f83-96af-3e5894435a2d",
      "ipAddress": "2401:4900:56f6:8238:a4c4:4ec4:339e:9fbb",
      "productArea": "livesend",
      "deviceType": "pc",
      "browser": "chrome",
      "browserVersion": "Chrome.129.0.0",
      "operatingSystem": "windows",
      "operatingSystemVersion": "Windows 10",
      "locale": null,
      "city": "Mumbai",
      "country": "India",
      "applicationType": "unknown",
      "application": "unknown"
    },
    "livesendSummary": {
      "sentBy": "729771ac-bcb9-da00-3a9e-acaef7e45d3a",
      "livesendLinkId": "42fb75e6-a5f2-f7d3-9a9a-caacec7db868",
      "deliveryIntegratorContext": null,
      "linkMembers": [
        {
          "email": "[email protected]",
          "externalUserId": "cacf018a-65cb-3015-8a27-8e96af52e101"
        }
      ],
      "livesendViewingSessionId": "110061e5-5020-4f83-96af-3e5894435a2d",
      "sessionStartedAt": "2024-10-09T09:52:56Z",
      "sessionEndedAt": "2024-10-09T09:53:33Z",
      "totalContent": 1,
      "totalContentViewed": 1,
      "totalContentDownloaded": 1,
      "totalDurationSeconds": 16,
      "detailsUrl": "https://qa01eastasia01.seismic.com/app#/engagementcenter/detail/97f7aea5-7e0b-4d7b-8938-a5a1338dd3a5",
      "livesendUrl": "https://bes-edge-qa-az-westus-wombat.seismic-dev.com:443/i/HJjY3IrxqqCoPLUSSIGNElYmRuzysGd8k1mlZ5IM3r3LjWCZpyw0tl8vik___mXQxIeq1x4uCGtucM5OVCL9R4gvbsh8P9Y0dOXHp3upyDEHkgjEjrq6QbLcajitfhIndTTxRuMd___6pVqFosS4xCqfzIN6XHqkveAeNPLUSSIGNfEm0oP03TftD7FNwEQUALSIGN?noTrack=true",
      "linkParameters": "",
      "notificationSetting": "Summary",
      "downloadFormatsSetting": "All",
      "summaryByContent": [
        {
          "content": {
            "repository": "workspace",
            "versionId": "a52bdf23-ae2c-4ba8-a174-dbeef3f192e5",
            "quickAccessPath": null,
            "name": "1Page",
            "id": "1133dbe2-2e5d-468d-81e9-067ba514c083",
            "type": "file",
            "pages": null
          },
          "pages": 4,
          "pagesViewed": 4,
          "durationSeconds": 16,
          "wasDownloaded": true,
          "downloadFormats": [
            "PDF"
          ],
          "wasViewed": true,
          "summaryByPage": [
            {
              "pageIndex": 1,
              "thumbnailImageUrl": null,
              "durationMilliseconds": 6850
            }
          ]
        }
      ]
    }
  },
  "id": "e40bbaab-f86e-e62b-d3c9-5104734edb18",
  "version": "livesend-session-summary-v2",
  "occurredAt": "2024-07-14T14:03:52.679592+00:00",
  "tenantId": "79caac86-4242-401f-bf63-4505f609dd22",
  "tenantName": "demo",
  "productArea": "Livesend"
}