LDXJobStatusV1

Occurs when job is done.Failed, Cancelled, Complete.

Webhook Payload

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

Property	Type	Description
id	string	Unique event id. The same event will have the same id
version	string	Version of the event schema
occurredAt	string	Timestamp when the event occured
tenantId	string	Unique 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
batchInstanceId	string	Unique batch instance id
teamSiteId	string	Unique team site id
batchId	string	Batch id
name	string	Name
status	string	Status
userId	string	User id
userName	string	User name
createdAt	string	Timestamp when the event was created
completedAt	string	Timestamp when the event was completed
duration	string	Duration of the event
variantCount	integer	Variant count
counts	object	counts counts object details
initiatedFromLiveDoc	boolean	Initiated from live doc

counts object details

Property	Type	Description
failed	integer	Failed count
canceled	integer	Canceled count
completed	integer	Completed count

Example

{
  "id": "GUID",
  "version": "LDXJobStatusV1",
  "occurredAt": "2023-01-20T21:13:25.268Z",
  "tenantId": "b4d8bb18-dc97-4e18-8049-50a04edf453f",
  "tenantName": "fsdev",
  "data": {
    "batchInstanceId": "36032adf-2435-485a-870f-b75520c0b6da",
    "teamSiteId": "47e52009-1ac8-4b89-bacc-3a2268725fb8",
    "batchId": "47e52009-1ac8-4b89-bacc-3a2268725fb8",
    "name": "Job name",
    "status": "Completed",
    "userId": "36032adf-2435-485a-870f-b75520c0b6da",
    "userName": "Bill Smith",
    "createdAt": "2023-01-20T21:13:25.268Z",
    "completedAt": "2023-01-20T21:13:25.268Z",
    "duration": "00:00:59.387791",
    "variantCount": 8,
    "counts": {
      "failed": 1,
      "canceled": 0,
      "completed": 7
    },
    "initiatedFromLiveDoc": false
  },
  "application": "LiveDocsExpress",
  "productArea": "LiveDocs"
}

Updated 6 days ago