LiveDocCompletedV2

Occurs when the requested format is generated from a LiveDoc template or there are failures during generating a LiveDoc.

Webhook Payload

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

Property	Type	Description
id	string	The unique ID for the event.
version	string	The version of the event.
occurredAt	string	The time when the event occurred.
tenantId	string	Tenant Id
tenantName	string	Tenant name
data	object	The container of the event details. data object details
application	string	Application
productArea	string	Product area

data object details

Property	Type	Description
requestId	string	The unique ID for the LiveDoc generation process.
userId	string	User ID
status	string	The final status of the LiveDoc generation process. [Generated
output	object	The output file information of the generated LiveDoc. output object details
seismicInstance	object	The information around generating a LiveDoc. The LiveDoc generation process is one of the stages that are managed in the Universal Content Builder (UCB). seismicInstance object details
clientDetails	object	Client information clientDetails object details
requester	object	The information about where the request was made from. requester object details
report	object	Report report object details
properties	array of objects	Additional LiveDoc generation information (name/value pairs). Such as the generated LiveDoc Blob information(ContainerName, BlobId) and the form options, etc. properties array object details

output object details

Property	Type	Description
format	string	The file format of the generated LiveDoc. [PPTX
fileName	string	Output file name
downloadUrl	string	The URL to download the generated LiveDoc.

seismicInstance object details

Property	Type	Description
instanceId	string	UCB lifecycle instance ID
instanceStageId	string	UCB lifecycle instance stage ID
instanceStageType	string	UCB lifecycle instance stage type. [LiveDocGeneration=2]
generator	string	Generator [LiveDoc]
origin	object	The information of the original LiveDoc template. origin object details

origin object details

Property	Type	Description
content	object	Content information content object details
repository	string	Repository of the original content [library
teamsiteId	string	Teamsite ID of the original content.
profileId	string	Profile ID of the original content.
profileVersionId	string	Profile version ID of the original content.
fullPathId	string	Full path ID in the DocCenter profile.
fullPathName	string	Full path name in DocCenter profile.
formId	string	Form Id
formName	string	Form name
googleFileId	string	Google file ID. The field is available when the original content is a Google document.

content object details

Property	Type	Description
name	string	Content name
id	string	Content ID
versionId	string	Content version ID
version	string	Content version
format	string	Content format

clientDetails object details

Property	Type	Description
name	string	Client name
application	string	Application
applicationOverride	string	Application override
productArea	string	Product area

requester object details

Property	Type	Description
name	string	Requester name [UCB]
id	string	Requester Id
location	string	Request location. [ContentManager

report object details

Property	Type	Description
createTime	number	The time the report was created.
lastUpdateTime	number	The time the report was last updated.

properties array object details

Property	Type	Description
name	string	Name
value	string	Value

Example

{
  "id": "F4D8308057AE7ADF05A4A80604518BDC2BF80F2BC37DD3EDE8725F639070B388",
  "version": "LiveDocCompletedV2",
  "occurredAt": "2024-03-31T09:16:50.545Z",
  "tenantId": "234b9f0d-853d-4210-b5d2-b0574e003fcc",
  "tenantName": "postreleaseqawest1",
  "data": {
    "requestId": "c9c564af-e5c9-4a4b-ac55-4f9f85662888",
    "userId": "7f9adfa5-71ed-9478-c3b5-90687be4ed04",
    "status": "Generated",
    "output": {
      "format": "PPTX",
      "fileName": "CCDS in LiveDoc",
      "downloadUrl": "https://bss-gn100.seismic.com/api/download/v1/blob?t=postreleaseqawest1&c=postreleaseqawest1&id=DownloadJobd27236db-a868-43be-a09d-bb0a109af111&et=20240331131655&isfullcontainername=True&sig=5pmblyHJRDdOlkYvPzFG%2FBBr0oZfvlDK1P%2F4tMO%2B9hY%3D"
    },
    "seismicInstance": {
      "instanceId": "caaa1740-23e1-48a9-9a17-297cd14ed4f0",
      "instanceStageId": "e58e0464-90a9-4214-a606-a22250a73699",
      "instanceStageType": "2",
      "generator": "LiveDoc",
      "origin": {
        "content": {
          "name": "CCDS in LiveDoc",
          "id": "0be17c58-9f53-404a-84db-e6832ed8f32f",
          "versionId": "40db45c4-b9d6-47a0-a2fb-0b96f0214ae8",
          "version": "1.0",
          "format": "pptx"
        },
        "repository": "doccenter",
        "teamsiteId": "1",
        "profileId": "abc0ed10-6572-481f-b67f-f0da9993e670",
        "profileVersionId": "522e0a0f-ce0e-4644-a4b4-4547bd00ec97",
        "fullPathId": "/dd2a076c82-2704-1a4e-762f-41d809deaff8/lf40db45c4-b9d6-47a0-a2fb-0b96f0214ae8",
        "fullPathName": "\\PostReleaseVerification(Don't delete)\\CCDS in LiveDoc",
        "formId": "d3663485-839a-4643-bd52-5ed3b1085bce",
        "formName": "CCDS in LiveDoc",
        "googleFileId": ""
      }
    },
    "clientDetails": {
      "name": "Doccenter",
      "application": "Web",
      "applicationOverride": "web",
      "productArea": "doccenter"
    },
    "requester": {
      "name": "UCB",
      "id": "a92fcb89-68d7-4335-9f1c-2c13703b8272",
      "location": "DocCenter"
    },
    "report": {
      "createTime": 1711876610545,
      "lastUpdateTime": 1711876615916
    },
    "properties": [
      {
        "name": "ContainerName",
        "value": "postreleaseqawest1"
      },
      {
        "name": "BlobId",
        "value": "DownloadJobd27236db-a868-43be-a09d-bb0a109af111"
      }
    ]
  },
  "application": "Web",
  "productArea": "doccenter"
}