The Hive Inspect API is a work in progress. It is available to a small group of accounts today, and the release for everyone is coming very soon. To ask for early access, message us from the chat bubble in your dashboard.
POST with a JSON body.
Events
Coming soon:
inspection.created and inspection.deleted.
Agents and clients are the same kind of record in Hive, so one set of
contact events covers both. Read roles in the message to tell them apart, for example ["Buyer Agent"].The message
Every event has the same outer shape:
A message from the Send test button also has
"test": true.
Request headers
Inspection events
Every inspection event sends the same sections indata.
Extra fields on some events
inspection.rescheduled adds the old time, so you can tell what changed:
inspection.published adds the inspection’s reports and their status:
inspection.canceled has inspection.status set to canceled and inspection.canceled_at set.
inspection.paid has inspection.payment_status set to paid.
inspection.payment_updated adds payment_details: the invoice, what each payer owes, every payment with its Stripe id, every refund, and bank payments the bank rejected. It holds the same fields as GET /v1/inspections/{id}/payments, with money in cents.
inspection.agreements_signed adds the inspection’s agreements. Archived agreements are left out.
inspection.completed adds both reports and agreements, in the shapes shown above.
When the paid, signed and completed events are sent
inspection.paidis sent when the payment status becomespaid. A partial payment does not send it. If a payment is reversed and the inspection is paid again later, it is sent again.inspection.payment_updatedis sent every time the payments change. That covers a payment, a partial payment, a payer share paid, a refund made or completed, and a bank payment the bank rejected. It arrives within about a minute of the change.inspection.payment_updatedtells you when a bank payment settles. While a bank payment is clearing, Hive checks it every few hours and sends the event again oncesettledbecomestrue. Usepayment_details.settledbefore you treat an inspection as fully paid.- The same payment state is sent once. Several changes that end in the same state send one message, and each state has its own event
id. inspection.agreements_signedis sent once, when every agreement on the inspection is signed, usually at the last signature. It is not sent for each signature. An inspection with no agreements never sends it.inspection.completedwaits for the inspection to happen. The inspection must be paid, have every agreement signed, have at least one report with every report published, and not be canceled. It is then sent at the inspection’s scheduled end time (start time plus duration), or right away if that time has already passed. An inspection with no scheduled time is sent as soon as it is complete.inspection.completedis sent once per completion. A retry of the same completion keeps the same eventid. If the inspection becomes complete again later, for example a report is unpublished and published again, or a new report is added and published, it is sent again with a newid.- Use
inspection.completedto ask for a review. It is the point where the client has paid, signed and received every report.
Contact events
data.contact holds the contact.
contact.updatedshows the contact as it is now. It does not list which fields changed. Several quick edits to one contact can arrive as a single event.- A tag change is an update. Adding or removing a tag sends
contact.updated. rolescomes from the contact’s inspections. A new contact with no inspection yet has an empty list. Being added to an inspection does not send an event on its own, but it does move that inspection’supdated_at, so anupdated_sincesync of inspections picks it up.contact.deletedsends the last known copy. Itstag_listandrolesare empty, because they were removed with the contact.- A merge sends
contact.deletedfor the contact that was merged away.

