Event Payload Examples - Runbook 

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

Runbook events

These events relate to actions taken on an entire runbook or a run of that runbook.

On Runbook Update (runbook.updated)

Fires when a runbook’s properties are changed.
Entity: The runbook itself.

This event is triggered any time the runbook’s metadata is updated—for example, if someone changes the name, environment, timings, or other custom fields. This lets you track changes or trigger workflows in external systems whenever a runbook is modified.

Example use case: Log all changes to runbook configurations in your audit system or send a notification to a team channel when the environment changes from "Staging" to "Production".

Sample payload: ‍

{
  "id": "e4a5d8c6-a8b2-4d21-8273-2d2c12e3a1f1",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:25:00.000Z",
    "type": "runbook.updated"
  },
  "meta": {
    "current_user": {
      "id": "1",
      "email": "user.one@example.com"
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "1",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "15",
        "type": "core.runbook"
      }
    }
  }
}

‍

On Run Start (run.started)

Fires when a new run (rehearsal or live) of a runbook is started.
Entity: The run object.
Metadata: Includes details about the current_run.

This event is triggered when someone starts executing a runbook—either as a rehearsal or a live run. It allows external systems to react at the moment execution begins.

Example use case: Automatically post a notification to a monitoring channel or update a dashboard when a critical runbook starts running.

Sample payload: ‍

{
  "id": "a9b8c7d6-e5f4-4a3b-2c1d-0e9f8a7b6c5d",
  "type": "core.event",
  "attributes": {
    "created_at": "2025-06-27T10:26:00.000Z",
    "type": "run.started"
  },
  "meta": {
    "current_user": {
      "id": "2",
      "email": "user.two@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"
    },
    "current_run": {
      "run_type": "rehearsal"
    }
  },
  "relationships": {
    "current_user": {
      "data": {
        "id": "2",
        "type": "core.user"
      }
    },
    "entity": {
      "data": {
        "id": "551",
        "type": "core.run"
      }
    },
    "runbook": {
      "data": {
        "id": "22",
        "type": "core.runbook"
      }
    }
  }
}