Connect WhizInvoice to the rest of your systems
Send enquiries in from your own forms, push jobs and invoices out to your own tools, and hear about things as they happen. API keys, a REST API and signed webhooks, on Business and up.
All in one settings page
Settings, API keys and webhooks, with a guide beside it.
The REST API
- Read and create
- Customers, sites, enquiries, jobs, quotes, invoices, payments and tasks
- Keys
- Full or read only, with an optional expiry date, shown once and revocable
- Safe to retry
- Idempotency-Key replays a create. The same external_id on an enquiry stays one enquiry
- Duplicates
- A customer email you already have answers with the existing record’s id
- Limits
- 120 calls a minute and 30 writes a minute per key, with Retry-After
- Paging and changes
- Pages with after_id, and an updated_since filter
The API reads and creates. It does not change or delete records. Those stay in the app.
Webhooks
Up to 10 addresses per business, each with the events it wants.
Five events
Enquiry received, Quote accepted, Invoice sent, Invoice paid and Job done.
Signed
Every send is signed with your secret and carries its event and delivery id, so you can check it and ignore repeats.
Retried for you
A failed send tries again on a schedule, up to six tries. Send again restarts it.
Send a test
Check an address from the settings page. It reports what came back.
Your data stays yours
- A key only ever reaches its own business’s records.
- A key on a business that drops below Business stops working, and webhooks stop sending. Nothing is deleted.
- Webhook addresses must be public https addresses. Redirects are not followed.
- Only the owner manages keys and webhooks. Technicians cannot see them.
Good to know
Which plans include the API?
Business and Multi brand. Business is US$13.99 a month or US$119.88 a year, with a 14 day free trial.
Where is the documentation?
The API guide sits in Settings, API keys and webhooks, beside your keys.
Can the API change or delete records?
No. It reads and creates. Changes and deletes stay in the app.
How do I check a webhook is really from WhizInvoice?
Every send carries a signature made with your secret. Check it, and use the delivery id to ignore a repeat.
Can I make a read only key?
Yes. A read only key is refused on every create.
Build on WhizInvoice
Make your first key with a 14 day free trial of Business.
Free plan forever. No card needed to start.