workflowManager.workflowSession.started
workflowManager.workflowSession.started
When an action is started by the driver, the workflow opens and a workflow session is started in the workflow manager module
Payload json
{
"eventBatchId": "a1b2c3d4-0000-0000-0000-000000000001",
"eventSubscriptionId": "a1b2c3d4-0000-0000-0000-000000000002",
"eventBatchTime": "2026-05-20T09:00:00.0000000Z",
"eventsData": [
{
"eventType": "workflowSession.started",
"eventVersion": 1,
"eventData": {
"workflowSessionId": "a1b2c3d4-0000-0000-0000-000000000001",
"workflowId": "a1b2c3d4-0000-0000-0000-000000000002",
"driverId": "a1b2c3d4-0000-0000-0000-000000000003",
"assetId": "a1b2c3d4-0000-0000-0000-000000000004",
"startTime": "2026-05-20T09:00:00Z",
"reportCodes": [
{
"reportCode": "anomaly",
"integratorCode": "sample"
}
],
"tags": {
"key": "value"
},
"status": "inProgress",
"organizationId": "a1b2c3d4-0000-0000-0000-000000000005",
"registeredOn": "2026-05-20T09:00:00Z",
"eventId": "a1b2c3d4-0000-0000-0000-000000000006",
"occurredOn": "2026-05-20T09:00:00Z"
}
}
]
}Field level Description
| Field | Type | Description |
|---|---|---|
WorkflowSessionId | Guid | Unique identifier of the workflow session. |
WorkflowId | Guid | Unique identifier of the workflow this session belongs to. |
DriverId | Guid? | Unique identifier of the driver. Omitted from the payload when null (WhoSeesWhat filtering may also null this field). |
AssetId | Guid | Unique identifier of the asset linked to this session. |
StartTime | DateTime | UTC timestamp when the workflow session started. |
ReportCodes | List<ReportCodeInfo> | List of report codes associated with this session. |
Tags | Dictionary<String, String> | Key-value pairs of custom metadata tags attached to the session. |
Status | String | Current feedback status of the session (inProgress, finished, cancelled). |
ReportCodeInfo
| Field | Type | Description |
|---|---|---|
ReportCode | String | The standardized report code type. |
IntegratorCode | String | Optional custom code provided by the integrator. Omitted when null. |
Updated 6 months ago
Did this page help you?