An API and webhooks, included in the plan.
Connect StoreBay to your accounting, your reporting or your own website. The account owner creates a key in StoreBay, and the reference is published for your developer.
Illustration: the API keys list in StoreBay’s developer settings, with a Create key button. Two active keys, “Reporting sheet” (sb_live_3f9a then dots, scopes reports:read, units:read) and “Website booking” (sb_live_c81d then dots, scopes reservations:write, units:read +1), and the line “Keys carry only the scopes you grant.”
How the API works.
Ask for the records you need.
- Units, customers, agreements, invoices and payments, each in a published format.
- Your own systems connect with a key, and each key is limited to the permissions it was given.
- A partner’s app has to ask for your permission first.
- The integrations page lists what else StoreBay connects to.
Illustration: a request to StoreBay’s API, a GET to /v1 with an Authorization header carrying a key, beside the records it can ask for: units at /v1/units, customers at /v1/contacts, agreements at /v1/agreements, invoices at /v1/invoices, payments at /v1/payments.
Hear when something changes.
- Webhooks tell your other software when, for example, a payment succeeds or a customer signs their licence.
- Each one is signed, so your systems can check it came from StoreBay.
- If your end is down, it’s tried up to eight times over about three days.
- A delivery that still fails shows as Exhausted in your delivery log, where you can send it again.
Illustration: the delivery log for one webhook endpoint. payment.succeeded: delivered after 1 attempt, response 200; agreement.signed: retrying after 3 attempts, response 503, with a Redeliver link; payment.succeeded: exhausted after 8 attempts, response 503, with a Redeliver link.
Questions about the API.
The account owner, in StoreBay’s developer settings. A key is shown once when it’s made, is limited to the permissions chosen for it, and can be replaced or switched off at any time.
Yes. We set up a separate test account on request, with its own keys.
No. The API and webhooks are included in the one plan, like everything else.
Reports, invoices and payments download as spreadsheets whenever you like. An invoice download holds up to 10,000 rows, so narrow a long list with filters first.