API quickstart
Developers · 8 min read · Updated 8/6/2026
The public API lets you create inspections from your own CRM or ERP, pull finished reports, and receive webhook callbacks as jobs progress.
Authentication
Create a token under Settings → API keys. Tokens are workspace-scoped and shown once. Send it as a bearer token on every request.
Requests are rate limited per token; the response headers report your remaining allowance.
Create an inspection
POST an inspection with the customer name and mobile number. The response includes the join link you can forward from your own system.
- Supply an external reference so results map back to your job record.
- Choose live or self-serve mode per request.
- Capture policy defaults to your workspace settings unless overridden.
Retrieve the report
Reports are generated asynchronously. Either poll the inspection resource until its report status reads succeeded, or subscribe to the webhook and react to the callback.
Webhooks
Register endpoints under Settings → Webhooks. Deliveries are signed, retried with backoff, and visible with their full delivery history in the dashboard.
- Verify the signature header before trusting a payload.
- Respond 2xx quickly and process asynchronously on your side.
- Failed deliveries can be replayed from the dashboard.
Frequently asked
- Is the API available on every plan?
- API access and webhooks are available on Pro and Enterprise plans.
- Can I rotate a token without downtime?
- Yes. Create the new token, deploy it, then revoke the old one — multiple active tokens are supported.