Message content

workflowManager.workflowSession.started

{
  "eventBatchId": "1762af18-b595-4a1d-addb-799811cc139f",
  "eventSubscriptionId": "b2a7ed17-de38-4979-bd48-33218401bddc",
  "eventBatchTime": "2024-08-30T14:34:23.1954476Z",
  "eventsData": [
    {
      "eventType": "workflowManager.workflowSession.started",
      "eventVersion": 1,
      "eventData": {
        "workflowSessionId": "f0b2717f-908a-42b0-9305-bf977d9bae8d", // Identifier of the workflow session (also added to action)
        "status": "pending", // status of the workflow session 
        "assetId": "03c470d0-8d21-41b0-9e7c-5c23199c9dfb",  // Identifier of the asset linked to the driver when filling in the answers
        "driverId": "b8e29a39-976b-4e39-8f0f-f9c7fd853d3b", // Identifier of the driver who filled in the answers
        "workflowId": "a1b09b2e-399f-4e04-810d-6cef1d633856", // Indetifier of the workflow (the questions)
        "startTime": "2024-09-23T10:30:45.556Z", // start time of the workflow session
        "reportCodes": [  // List of codes linked to the IS activity to give meaning to the IS activity 
          {
              "reportCode": "planningActivity",
              "integratorCode": null
          }
        ],
        "tags": { // Context information about the initiating event of this workflow session
            "trip.id": "4874b0e4-3772-4188-b5aa-4636aba9e834",
            "leg.id": "2a3dc16e-bf9b-4db3-8524-9f29d4b8d611",
            "mission.id": "c5997dea-3402-4de6-9b13-6492d09a363f",
            "action.id": "66e9f07f-bbb4-484d-9dc9-b0090d56112c"
        }
      },
      "organizationId": "e6c0f169-6f7a-4981-8e1a-0ca8344c4a77",
      "registeredOn": "2024-08-30T14:34:22.016Z",
      "eventId": "702ade4e-973a-42a1-a7cb-1c30bbbccb6d",
      "occurredOn": "2024-08-30T14:34:22.016Z"
    }
  ]
}

workflowManager.workflowSession.updated

Provides the complete list of answers for each update. 
{
  "eventBatchId": "1762af18-b595-4a1d-addb-799811cc139f",
  "eventSubscriptionId": "b2a7ed17-de38-4979-bd48-33218401bddc",
  "eventBatchTime": "2024-08-30T14:34:23.1954476Z",
  "eventsData": [
    {
      "eventType": "workflowManager.workflowSession.updated",
      "eventVersion": 1,
      "eventData": {
        "workflowSessionId": "f0b2717f-908a-42b0-9305-bf977d9bae8d", // Identifier of the workflow session (also added to action)
        "answers": [  // Complete list of answers collected during this workflow session
          {
              "value": "0", // The value entered by the driver
              "registeredOn": "2024-09-23T10:30:57.396Z", // The timestamp of the answer, offline answer = timestamp of phone, online answer = timestamp of backend
              "reportCodes": [ // List of codes linked to the answer to give meaning to the value 
                  {
                      "reportCode": "supplier", // Report code from Tx-Design
                      "integratorCode": "82"    // Integrator code from Tx-Design
                  }
              ],
              "tags": {}  // Context information about the specific answer (e.g. order or loadcarrier info)
          },
          ...
        ],
      },
      "organizationId": "e6c0f169-6f7a-4981-8e1a-0ca8344c4a77",
      "registeredOn": "2024-08-30T14:34:22.016Z",
      "eventId": "702ade4e-973a-42a1-a7cb-1c30bbbccb6d",
      "occurredOn": "2024-08-30T14:34:22.016Z"
    }
  ]
}

workflowManager.workflowSession.finished

{
  "eventBatchId": "1762af18-b595-4a1d-addb-799811cc139f",
  "eventSubscriptionId": "b2a7ed17-de38-4979-bd48-33218401bddc",
  "eventBatchTime": "2024-08-30T14:34:23.1954476Z",
  "eventsData": [
    {
      "eventType": "workflowManager.workflowSession.finished",
      "eventVersion": 1,
      "eventData": {
        "workflowSessionId": "f0b2717f-908a-42b0-9305-bf977d9bae8d", // Identifier of the workflow session (also added to action)
        "status": "finished", // status of the workflow session 
        "endTime": "2024-09-23T10:31:27.654Z",   // end time of the workflow session
      },
      "organizationId": "e6c0f169-6f7a-4981-8e1a-0ca8344c4a77",
      "registeredOn": "2024-08-30T14:34:22.016Z",
      "eventId": "702ade4e-973a-42a1-a7cb-1c30bbbccb6d",
      "occurredOn": "2024-08-30T14:34:22.016Z"
    }
  ]
}