Event Payload Examples - Task

Custom payloads are not supported yet however below are some example JSON payloads to show the payload Cutover sends for a triggered event. 

Task and Integration Events

These events provide granular updates for individual tasks and the integrations they may trigger.

On Task Create (task.created)

Fires when a new task is created within a runbook.

This event is triggered any time a task is added to a runbook—whether manually by a user or programmatically through the API. It helps external systems stay in sync with task creation activity.

Example use case: Automatically log new tasks in a third-party system like Jira or send a notification to a project channel when tasks are added during planning.

Sample payload:

{
  "id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:27:00.000Z",
    "type": "task.created"
  },
  "meta": {
    "current_user": {
      "id": "496",
      "email": "user.three@example.com"
    },
    "runbook": {
      "id": "7087",
      "name": "Integration task with ServiceNow",
      "frontend_url": "https://example.cutover.com/#/app/workspace/runbooks/7087/current_version/tasks/list",
      "start_actual": "2025-06-27T10:02:56.384Z"
    },
    "task": {
      "id": "4",
      "name": "Newly Created Task"
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "496",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "4",
        "type": "core.task"
      }
    },
    "runbook": {
      "data": {
        "id": "7087",
        "type": "core.runbook"
      }
    }
  }
}

On Task Start (task.started)

This event fires when a task's status changes to in-progress—typically when a user begins work on the task in a runbook.

Use this event when you want to:

• Trigger a message to let teams know a task has started.
• Initiate time tracking in a third-party system.
• Send instructions or resources to the assignee.
• Update the task status in another integrated platform.
  

Example use cases:

• Post a message in a Microsoft Teams channel when critical tasks start.
• Start a timer in a time management tool.
• Automatically log a “task started” entry in a service desk tool like ServiceNow.

Sample payload:

{
  "id": "f8c2b5e9-7a9f-4b1d-a3e2-6c3e1a1d9b3a",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:28:00.000Z",
    "type": "task.started"
  },
  "meta": {
    "current_user": {
      "id": "496",
      "email": "user.four@example.com"
    },
    "runbook": {
      "id": "7087",
      "name": "Integration task with ServiceNow",
      "frontend_url": "https://example.cutover.com/#/app/workspace/runbooks/7087/current_version/tasks/list",
      "start_actual": "2025-06-27T10:02:56.384Z"
    },
    "task": {
      "id": "3",
      "name": "Integration Task"
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "496",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "3",
        "type": "core.task"
      }
    },
    "runbook": {
      "data": {
        "id": "7087",
        "type": "core.runbook"
      }
    }
  }
}

‍

On Task Update (task.updated)

Fires when a task is updated within a runbook.
The entity is the task itself.
The meta block contains a changes object detailing the updates made to the task.

Example use case:If a task’s name or deadline is changed during a run, this event can trigger an automated notification to the team, ensuring everyone is immediately aware of the update and can adjust their work accordingly.

Sample payload:

{
  "id": "33e9dcdc-2b1d-4ae7-9b40-136546995ba9",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:29:00.000Z",
    "type": "task.updated"
  },
  "meta": {
    "current_user": {
      "id": "496",
      "email": "user.five@example.com"
    },
    "runbook": {
      "id": "7087",
      "name": "Integration task with ServiceNow",
      "frontend_url": "https://example.cutover.com/#/app/workspace/runbooks/7087/current_version/tasks/list",
      "start_actual": "2025-06-27T10:02:56.384Z"
    },
    "task": {
      "id": "3",
      "name": "Integration Task with new name"
    },
    "changes": {
      "name": [
        "Integration Task",
        "Integration Task with new name"
      ]
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "496",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "3",
        "type": "core.task"
      }
    },
    "runbook": {
      "data": {
        "id": "7087",
        "type": "core.runbook"
      }
    }
  }
}

‍

On Integration Failure (integrations.failed)

Fires when an automated task integration fails.
The entity is the integration task that failed. 

The meta block includes debug_data to help with troubleshooting the failure.

Example use case:
If an integration with a third-party system like ServiceNow or Slack fails during a run, this event can trigger an immediate alert to the support team, enabling them to quickly investigate and resolve the issue before it impacts the overall process.

Sample payload:

{
  "id": "b6d0e1c3-3e1a-4c8c-b9d9-0a8b3c5a2d7b",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:30:00.000Z",
    "type": "integrations.failed"
  },
  "meta": {
    "current_user": {
      "id": "496",
      "email": "user.six@example.com"
    },
    "runbook": {
      "id": "7087",
      "name": "Integration task with ServiceNow",
      "frontend_url": "https://example.cutover.com/#/app/workspace/runbooks/7087/current_version/tasks/list",
      "start_actual": "2025-06-27T10:02:56.384Z"
    },
    "task": {
      "id": "3",
      "name": "Integration Task with new name"
    },
    "debug_data": {
          "url": "https://api.cutover.com/core/runbooks/1",
          "auth_type": "No Auth",
          "request_type": "POST",
          "request_headers": "{}",
          "request_parameters": "{}",
          "request_body": "{}",
          "response_headers": "{\"date\":\"Wed, 18 Jun 2025 09:41:27 GMT\",\"content-type\":\"application/json\",\"content-length\":\"87\",\"connection\":\"keep-alive\",\"vary\":\"Origin\"}",
          "response_body": "{\"errors\":[{\"title\":\"Not Allowed\",\"detail\":\"This endpoint has not been implemented.\"}]}",
          "response_status": "500"
   }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "496",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "3",
        "type": "core.task"
      }
    },
    "runbook": {
      "data": {
        "id": "7087",
        "type": "core.runbook"
      }
    },
    "integration_setting": {
      "data": {
        "id": "5",
        "type": "core.integration_action_item"
      }
    }
  }
}

‍

On Integration Cancelled (integrations.cancelled)

Fires when a running task integration is manually cancelled.
The entity is the integration task that was cancelled.

Example use case:
If a task integration (such as a deployment script or notification) needs to be stopped mid-run due to an unexpected issue, this event can notify the operations team immediately so they can take appropriate follow-up actions and update stakeholders accordingly.

Sample payload:

{
  "id": "2a1b4c3d-8e7f-4a6b-9c5d-1e2f3a4b5c6d",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:31:00.000Z",
    "type": "integrations.cancelled"
  },
  "meta": {
    "current_user": {
      "id": "496",
      "email": "user.seven@example.com"
    },
    "runbook": {
      "id": "7087",
      "name": "Integration task with ServiceNow",
      "frontend_url": "https://example.cutover.com/#/app/workspace/runbooks/7087/current_version/tasks/list",
      "start_actual": "2025-06-27T10:02:56.384Z"
    },
    "task": {
      "id": "3",
      "name": "Integration Task with new name"
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "496",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "3",
        "type": "core.task"
      }
    },
    "runbook": {
      "data": {
        "id": "7087",
        "type": "core.runbook"
      }
    },
    "integration_setting": {
      "data": {
        "id": "5",
        "type": "core.integration_action_item"
      }
    }
  }
}

‍

On Integration Triggered (integrations.connect)

Fires when a task integration is first initiated.
The entity is the integration task that has started.

Example use case:When an automated deployment or notification task begins, this event can trigger alerts or logging in your monitoring system to track the start of critical processes in real time.

Sample payload: 

{
  "id": "5e4f3a2b-1c8d-4b6a-9e7f-8d5c3b1a2e9f",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:32:00.000Z",
    "type": "integrations.connect"
  },
  "meta": {
    "current_user": {
      "id": "496",
      "email": "user.eight@example.com"
    },
    "runbook": {
      "id": "7087",
      "name": "Integration task with ServiceNow",
      "frontend_url": "https://example.cutover.com/#/app/workspace/runbooks/7087/current_version/tasks/list",
      "start_actual": "2025-06-27T10:02:56.384Z"
    },
    "task": {
      "id": "3",
      "name": "Integration Task with new name"
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "496",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "3",
        "type": "core.task"
      }
    },
    "runbook": {
      "data": {
        "id": "7087",
        "type": "core.runbook"
      }
    },
    "integration_setting": {
      "data": {
        "id": "5",
        "type": "core.integration_action_item"
      }
    }
  }
}

‍

On Integration Success (integrations.success)

Fires when an automated task integration completes successfully.
The entity is the integration task that finished without errors.

Example use case:
When a deployment or data sync task completes successfully, this event can trigger notifications to teams or update dashboards, confirming that the process finished as expected.

Sample payload:

{
  "id": "9d8c7b6a-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:33:00.000Z",
    "type": "integrations.success"
  },
  "meta": {
    "current_user": {
      "id": "496",
      "email": "user.nine@example.com"
    },
    "runbook": {
      "id": "7087",
      "name": "Integration task with ServiceNow",
      "frontend_url": "https://example.cutover.com/#/app/workspace/runbooks/7087/current_version/tasks/list",
      "start_actual": "2025-06-27T10:02:56.384Z"
    },
    "task": {
      "id": "3",
      "name": "Integration Task with new name"
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "496",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "3",
        "type": "core.task"
      }
    },
    "runbook": {
      "data": {
        "id": "7087",
        "type": "core.runbook"
      }
    },
    "integration_setting": {
      "data": {
        "id": "5",
        "type": "core.integration_action_item"
      }
    }
  }
}

‍