PeopleForce

Early access

Company API v4 is the next-generation API and is under active development. Endpoints and fields may still change.

Overtime requests

Webhook topics and example payloads for the overtime-request lifecycle.

PeopleForce offers four webhook topics covering the overtime-request lifecycle:

  • overtime_request_create — an overtime request is created
  • overtime_request_update — an overtime request is updated
  • overtime_request_approve — an overtime request is approved
  • overtime_request_destroy — an overtime request is deleted

Overtime request created

Triggered instantly, as soon as the overtime request is created. Action: overtime_request_create.

{
  "action": "overtime_request_create",
  "data": {
    "id": 4821,
    "attributes": {
      "date": "2026-08-14",
      "starts_at": "2026-08-14T18:00:00.000+00:00",
      "ends_at": "2026-08-14T20:30:00.000+00:00",
      "minutes": 150,
      "comment": "Release deployment support",
      "state": "pending"
    },
    "project": { "id": 132, "name": "Platform migration" },
    "employee": {
      "id": 2632,
      "first_name": "Scott",
      "last_name": "Pilgrim"
    },
    "meta": {
      "created_at": "2026-08-13T09:12:03.841+00:00",
      "updated_at": "2026-08-13T09:12:03.841+00:00"
    }
  }
}

Overtime request updated

Triggered instantly, as soon as the overtime request is updated. Action: overtime_request_update.

{
  "action": "overtime_request_update",
  "data": {
    "id": 4821,
    "attributes": {
      "date": "2026-08-14",
      "starts_at": "2026-08-14T18:00:00.000+00:00",
      "ends_at": "2026-08-14T21:00:00.000+00:00",
      "minutes": 180,
      "comment": "Release deployment support, extended",
      "state": "pending"
    },
    "project": { "id": 132, "name": "Platform migration" },
    "employee": {
      "id": 2632,
      "first_name": "Scott",
      "last_name": "Pilgrim"
    },
    "meta": {
      "created_at": "2026-08-13T09:12:03.841+00:00",
      "updated_at": "2026-08-13T09:20:47.116+00:00"
    }
  }
}

Overtime request approved

Triggered instantly, as soon as the last approver in the approval flow approves the request and its status changes to Approved. Action: overtime_request_approve.

{
  "action": "overtime_request_approve",
  "data": {
    "id": 4821,
    "attributes": {
      "date": "2026-08-14",
      "starts_at": "2026-08-14T18:00:00.000+00:00",
      "ends_at": "2026-08-14T21:00:00.000+00:00",
      "minutes": 180,
      "comment": "Release deployment support, extended",
      "state": "approved"
    },
    "project": { "id": 132, "name": "Platform migration" },
    "employee": {
      "id": 2632,
      "first_name": "Scott",
      "last_name": "Pilgrim"
    },
    "meta": {
      "created_at": "2026-08-13T09:12:03.841+00:00",
      "updated_at": "2026-08-13T10:05:12.298+00:00"
    }
  }
}

Overtime request deleted

Triggered instantly, as soon as the overtime request is deleted. Action: overtime_request_destroy.

{
  "action": "overtime_request_destroy",
  "data": {
    "id": 4821,
    "attributes": {
      "date": "2026-08-14",
      "starts_at": "2026-08-14T18:00:00.000+00:00",
      "ends_at": "2026-08-14T21:00:00.000+00:00",
      "minutes": 180,
      "comment": "Release deployment support, extended",
      "state": "pending"
    },
    "project": { "id": 132, "name": "Platform migration" },
    "employee": {
      "id": 2632,
      "first_name": "Scott",
      "last_name": "Pilgrim"
    },
    "meta": {
      "created_at": "2026-08-13T09:12:03.841+00:00",
      "updated_at": "2026-08-13T09:12:03.841+00:00"
    }
  }
}

On this page