Skip to main content

Issue events

issue.created

Fired when a new maintenance issue is created, whether from an inbound message, web form, or the dashboard.
{
  "event": "issue.created",
  "timestamp": "2025-03-14T10:00:00.000Z",
  "data": {
    "id": "iss_01HXYZ",
    "code": "ISS-42",
    "title": "Boiler not heating",
    "description": "The boiler has not been producing hot water since yesterday morning.",
    "priority": 2,
    "status": "reported",
    "intakeChannel": "email",
    "tenant": {
      "id": "ten_01HABC",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "phoneNumber": "+447700900000"
    },
    "unit": {
      "id": "unit_01HDEF",
      "fullAddress": "Flat 3B, 14 High Street, London, E1 6RF"
    },
    "createdAt": "2025-03-14T10:00:00.000Z"
  }
}

issue.updated

Fired when an issue’s details are updated (title, description, priority, etc.).
{
  "event": "issue.updated",
  "timestamp": "2025-03-14T11:30:00.000Z",
  "data": {
    "id": "iss_01HXYZ",
    "code": "ISS-42",
    "title": "Boiler not heating",
    "priority": 3,
    "status": "in_progress",
    "updatedAt": "2025-03-14T11:30:00.000Z"
  }
}

issue.status_changed

Fired when an issue moves to a new status.
{
  "event": "issue.status_changed",
  "timestamp": "2025-03-14T12:00:00.000Z",
  "data": {
    "id": "iss_01HXYZ",
    "code": "ISS-42",
    "previousStatus": "reported",
    "status": "in_progress",
    "updatedAt": "2025-03-14T12:00:00.000Z"
  }
}
Possible status values:
StatusDescription
reportedIssue has been logged, not yet actioned
in_progressWork is underway
completedIssue has been resolved
cancelledIssue was closed without resolution

Priority reference

Issues use a numeric priority scale:
ValueLabel
0Emergency
1High
2Medium
3Low