Workflow completed

Configure a webhook to be informed when a workflow has been completed by a device. The webhook will POST the a payload refering to the executed workflow and the various steps included therein to the endpoint you configure in the platform.

Important: note that because of the offline nature of devices (sometimes, and depending on network conditions), it may occur that a workflow has been completed on/by a device, before uploading all data pertaining to that workflow. In that case such information will thus be missing. This is an exceptional situation, but when a complete payload is required, your logic may need to perform polling or a (delayed) API call to collect the full data set.

Example payload

Example payload response may look like this:

{
    "id": 5807109,
    "client_key": "nepuz",
    "workflow_id": 10099,
    "reference": "1234567",
    "file_id": 7918698,
    "tenant_id": 1,
    "submit_date_time": "2023-12-11T15:02:51+00:00",
    "created_at": "2023-12-11T15:02:56.727000Z",
    "updated_at": "2023-12-11T15:03:46.313000Z",
    "deleted_at": null,
    "completed_at": "2023-12-11T15:03:46+00:00",
    "workflow_run_steps": [
        {
            "id": 25338364,
            "entity_type": "uploads",
            "status": "done",
            "entity_ids": [
                65517578
            ],
            "device_id": 17543,
            "tenant_id": 1,
            "workflow_step_id": 63120,
            "workflow_run_id": 5807109,
            "submit_date_time": "2023-12-11T15:02:51+00:00",
            "created_at": "2023-12-11T15:02:56+00:00",
            "updated_at": "2023-12-11T15:02:56+00:00",
            "deleted_at": null
        },
        {
            "id": 25338414,
            "entity_type": "uploads",
            "status": "done",
            "entity_ids": [
                65517646
            ],
            "device_id": 17543,
            "tenant_id": 1,
            "workflow_step_id": 63124,
            "workflow_run_id": 5807109,
            "submit_date_time": "2023-12-11T15:03:40+00:00",
            "created_at": "2023-12-11T15:03:41+00:00",
            "updated_at": "2023-12-11T15:03:41+00:00",
            "deleted_at": null
        }
    ]
}

Explained: this workflow completed after 2 steps have been completed. The file this workflow can be found in has the id 7918698 and has your reference "1234567". Using the file/{id} API, you can thus retrieve the full file content with api.cargosnap.com/api/v2/files/7918698. The array with 'workflow_run_steps' represents the known status of each of the steps executed in the workflow, including their unique ID's. When collecting the file from the step above, all individual items will be present in the API payload also (unless deleted in the interim period).