API and webhooks

If you have a developer, or a website builder that can post data, Homeforce's API and webhooks let you connect almost anything. Owners and admins can manage them in Settings → Developers.

#API keys

1. Click New key.
2. Give it a Name, like "Website form".
3. Tick only the scopes it needs.
4. Click Create key.
5. Copy the key right away. It won't be shown again.

Scope	Allows
read:customers / write:customers	Look up / create customers
read:jobs / write:jobs	Look up / create jobs
read:invoices	Look up invoices
write:leads	Create leads
write:locations	Send vehicle or tech locations
manage:hooks	Let Zapier or Make subscribe to events

Each key shows when it was last used. Click Revoke to turn a key off. Anything using it stops working.

#The API

Send the key as a Bearer token. JSON in, JSON out. Endpoints:

• GET / POST /api/v1/customers
• GET / POST /api/v1/jobs
• GET /api/v1/invoices
• POST /api/v1/leads
• POST /api/v1/locations

The Quick start section on the page shows ready-to-copy examples with your account's address.

#Webhooks

Webhooks tell another system when something happens in Homeforce.

1. Enter your Endpoint URL.
2. Under Events, list the events you want, separated by commas, like job.created, invoice.paid, estimate.approved, or * for all.
3. Click Add endpoint.
4. Click Send test to check it arrives.

Each delivery is signed. Your developer should check the Homeforce-Signature header against the endpoint's signing secret (an HMAC-SHA256 of the timestamp and body).

Recent deliveries shows the last attempts, with delivered, failed or pending status, the response code and number of attempts.