Drives
A drive is one inspector's pass through a community. Its summary is the inspection record: which homes were passed, which were skipped and why, and what was found.
How it flows
- An inspector starts a drive: open items only, or the whole community.
- When they end it, you get
drive.completed: stops done, stops skipped with reasons, violations created and re-check results. - Use it as the inspection record for the community, or to bill the visit.
The Drive object
| idrequiredstring | |||||||||||
| titlestring | |||||||||||
| started_atrequiredstring (date-time) | |||||||||||
| ended_atstring (date-time) · nullable | |||||||||||
| inspectorrequiredPerson | |||||||||||
| stopsrequiredobject | 3 fields
| ||||||||||
| violations_createdarray of string | |||||||||||
| rechecksarray of object | 2 fields
|
Sample
{
"id": "sess-ho4l8rev40-0",
"title": "Open items: Nov 13",
"started_at": "2026-11-13T16:00:00.000Z",
"ended_at": "2026-11-13T16:00:00.000Z",
"inspector": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"stops": {
"total": 7,
"completed": 0,
"skipped": []
},
"violations_created": [
"f-ho4l8rev40-3"
],
"rechecks": [
{
"violation_id": "f-ho4l8rev40-3",
"result": "fixed"
},
{
"violation_id": "f-wce-3",
"result": "still_open"
}
]
}Webhook events
Sent to your endpoint as they happen, signed as described in Webhooks & signing. The samples are real output from the HOACraft app, checked against the code on every build.
EVENTdrive.completed
An inspector ended a drive
data fields
| driverequiredDrive |
Sample payload
{
"id": "evt-ho4l8rev40-m",
"type": "drive.completed",
"api_version": "2026-11-01",
"created_at": "2026-11-13T16:00:00.000Z",
"community": {
"id": "willow-creek",
"name": "Willow Creek Estates"
},
"data": {
"drive": {
"id": "sess-ho4l8rev40-0",
"title": "Open items: Nov 13",
"started_at": "2026-11-13T16:00:00.000Z",
"ended_at": "2026-11-13T16:00:00.000Z",
"inspector": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"stops": {
"total": 7,
"completed": 0,
"skipped": []
},
"violations_created": [
"f-ho4l8rev40-3"
],
"rechecks": [
{
"violation_id": "f-ho4l8rev40-3",
"result": "fixed"
},
{
"violation_id": "f-wce-3",
"result": "still_open"
}
]
}
}
}Endpoints
Planned REST API, not live yet. Base URL https://sandbox.api.hoacraft.com/v1, Authorization: Bearer <key>. See basics.
List completed drives
GET/drives
Parameters
| community_idquery · string | |
| sincequery · string (date-time) | |
| cursorquery · string | |
| limitquery · integer | default 100 · min 1 · max 500 |
Responses
| 200 | A page of drives.object |
Example request
curl -X GET "https://sandbox.api.hoacraft.com/v1/drives" \
-H "Authorization: Bearer $HOACRAFT_API_KEY"
Example response
{
"data": [
{
"id": "sess-ho4l8rev40-0",
"title": "Open items: Nov 13",
"started_at": "2026-11-13T16:00:00.000Z",
"ended_at": "2026-11-13T16:00:00.000Z",
"inspector": {
"id": "staff-dana",
"name": "Dana Whitfield"
},
"stops": {
"total": 7,
"completed": 0,
"skipped": []
},
"violations_created": [
"f-ho4l8rev40-3"
],
"rechecks": [
{
"violation_id": "f-ho4l8rev40-3",
"result": "fixed"
},
{
"violation_id": "f-wce-3",
"result": "still_open"
}
]
}
],
"next_cursor": "string"
}