Use the API and webhooks
Create API keys so other software can read your books or add contacts and invoices, and get told when things happen with webhooks.
The API lets your own software or tools talk to your books. Webhooks do the reverse: Billbook tells your software when something happens. Only an owner or admin can set them up.
How do I create an API key?
- Open SettingsAPI & webhooks and choose Create key.
- Give it a Name after the app that will use it.
- Tick Allow writing: create contacts and invoices (otherwise read only) only if it needs to add things.
- Choose Create key, then Copy key and store it somewhere safe.
You only see the key once
Lost it? Revoke it and create another. A key also stops working if the person who made it leaves the business.
How do I add a webhook?
- Choose Add endpoint.
- Enter the URL to send to and tick the Events, like Invoice paid in full or Bill approved.
- Copy the signing secret that shows next, and put it in the app that receives the webhooks.
- Choose Send a test event to check it works.
Every event is signed with the endpoint's secret so your app can check it came from Billbook. Failed deliveries are retried for up to a day.
How do I see what was sent?
Open Recent deliveries under the endpoint. Choose Resend on any delivery to send it again, or Pause the endpoint while you fix things.
Next
Connect apps like Shopify and Square
Link the other software your business uses so its sales land in your books each day, and see how each connection is going.
Invite people and choose what they can do
Bring your team into your books, give each person a role, change it later, and hand over ownership if you need to.
Something wrong on this page? Tell us
Last updated on