Pay runs and payslips. Samples show the envelope; data.object of an event that has a snapshot carries the object's fields as of the event (shown here with its type and id). See the envelope.

pay_run.approved#

A pay run was approved.

Object: pay_run · module payroll: no event is published for a company where it is hidden or off.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b10",
  "object": "event",
  "type": "pay_run.approved",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1000",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "PayRun",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}

pay_run.calculated#

A pay run was calculated.

Object: pay_run · module payroll: no event is published for a company where it is hidden or off.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b11",
  "object": "event",
  "type": "pay_run.calculated",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1001",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "PayRun",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}

pay_run.paid#

A pay run was paid.

Object: pay_run · module payroll: no event is published for a company where it is hidden or off.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b12",
  "object": "event",
  "type": "pay_run.paid",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1002",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "PayRun",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}

payslip.finalised#

A payslip was finalised.

Object: payslip · module payroll: no event is published for a company where it is hidden or off.

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b13",
  "object": "event",
  "type": "payslip.finalised",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1003",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Payslip",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}