LiveDocCompletedV1
Occurs when the requested format is generated from a LiveDoc template or there are failures during generating a LiveDoc.
End of Life
This service is scheduled for deprecation on 2024-07-29. Please work with your CSM to be part of the change management initiative.
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 occured |
| 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 generating process |
| createTime | string | The time when the request was created |
| updateTime | string | The time when the request was updated |
| status | string | The final status of the LiveDoc generating process. [Generated |
| output | object | The output information of the generated LiveDoc output object details |
| properties | array of objects | Additional LiveDoc generating information (name/value pairs). e.g. The generating process status. e.g. the form options. properties array object details |
| errors | array of objects | Errors errors array object details |
output object details
| Property | Type | Description |
|---|---|---|
| format | string | The file format of the generated LiveDoc. [PPTX |
| blob | object | The blob information where the generated LiveDoc is stored blob object details |
| properties | array of objects | Additional output information (name/value pairs) properties array object details |
blob object details
| Property | Type | Description |
|---|---|---|
| container | string | Blob container name |
| id | string | Blob container Id |
| length | string | Blob data length |
properties array object details
| Property | Type | Description |
|---|---|---|
| name | string | Name |
| value | string | Value |
properties array object details
| Property | Type | Description |
|---|---|---|
| name | string | Name |
| value | string | Value |
errors array object details
| Property | Type | Description |
|---|---|---|
| message | string | Message |
Example
{
"id": "GUID",
"version": "LiveDocCompletedV1",
"occurredAt": "2023-06-27T21:13:25.268Z",
"tenantId": "524cb548-d9d2-4cfb-8e4a-8498cfc5aa1b",
"tenantName": "slivedoctest",
"data": {
"requestId": "[guid]",
"createTime": "[long-unixDateTimeMilliseconds]",
"updateTime": "[long-unixDateTimeMilliseconds]",
"status": "[Generated|Failed]",
"output": {
"format": "[PPTX|DOCX|PDF|GLISES|GDOC|EXCEL]",
"blob": {
"container": "slivedoctest",
"id": "[blodId]",
"length": "[long]",
"fragments": [
1234,
4567
]
},
"properties": [
{
"name": "[propName1]",
"value": "[propValue1]"
},
{
"name": "[propName2]",
"value": "[propValue2]"
}
]
},
"properties": [
{
"name": "[propName1]",
"value": "[propValue1]"
},
{
"name": "[propName2]",
"value": "[propValue2]"
}
],
"errors": [
{
"message": "error message when status is failed"
}
]
},
"application": "[clientDetails.Application]",
"productArea": "[clientDetails.ProductArea]"
}
Updated 6 days ago