Workflows
Webhooks

Workflow Webhooks

If configured, the workflow results will be shared using a call to the provided webhook URL. The outcome of the workflow may be used to determine actions required, if any.

Example

This is an example output of a workflow which does 3 jobs, but failed at the second job.

{
  "id": "f66ec070-c9f9-524d-b01c-0cf617666a53",
  "event": "WORKFLOW_RESULT",
  "created": 1711528670,
  "payload": {
    "jobs": [
      {
        "id": "6f13c446-e586-42ca-b4ce-7d43644caefa",
        "status": "SUCCESS",
        "job_name": "ips",
        "created_at": "2024-03-27T08:36:52.846Z",
        "finished_at": "2024-03-27T08:36:52.957Z"
      },
      {
        "id": "b946dce5-c729-48f0-8aa2-20604bef83ee",
        "status": "FAILURE",
        "job_name": "peer_ips",
        "created_at": "2024-03-27T08:36:52.980Z",
        "finished_at": "2024-03-27T08:37:49.779Z"
      }
    ],
    "status": "FAILURE",
    "template": {
      "id": "d56c4de1-1eff-4754-8806-82ca33395057",
      "name": "Basic Node Checks Workflow",
      "description": "The workflow of basic checks done for a node. Steps will always run."
    },
    "created_at": "2024-03-27T08:36:52.837Z",
    "finished_at": "2024-03-27T08:37:49.806Z",
    "workflow_run_id": "95356502-6bb8-473a-8412-9fc79eb4c66b"
  }
}
TriggersAPI Docs