Skip to content
Submit a Support Ticket
  • There are no suggestions because the search field is empty.

Getting started with Developer Tools

You can connect your own software to your Autobooks account. The Developer section in the left menu gives you three tools: API Keys, Webhooks, and Documentation.

  • API keys let your software work with your Autobooks account. Once connected, your software can view and create invoices, customers, and products, and email invoices.
  • Webhooks work the other way: Autobooks sends a message to your web address when something happens. Currently, Autobooks sends a message when a customer initiates a payment.
  • Documentation explains everything inside the app, with examples your developer can copy.

Do I need this? 

Only if your business uses its own software or website and you want it to work with Autobooks automatically. If you don't, you can skip this feature. Everything else in Autobooks works the same.

Working with a developer? Since only the primary administrator can open Developer, you'll do the first step:

  1. Create an API key and/or webhook (steps below).
  2. Securely share the client ID and key with your developer. Don't send keys by regular email or text.
  3. Download the entire OpenAPI spec in the Documentation > OpenAPI spec and provide the download to your developer.

Where to find it

Select Developer in the navigation left menu. It opens to Documentation and expands to show Documentation, API Keys, and Webhooks.

Don't see the Developer tab?

  • Your financial institution must offer this feature. If it's not in your menu, contact your financial institution.
  • Only the primary administrator of your Autobooks account can see and use Developer. Other users on your account can't access it.
  • Developer isn't available when Autobooks is in accounting-only mode.

If you see "We couldn't check whether this account has API access," select Retry or reload the page. This is a loading issue, not a sign you lack access.

How setup works

Create an API key → Save your client ID and keys → Create a webhook → Send a test event → Go live

We recommend that you (or your developer) start by reading Developer > Documentation.

Using the documentation

The documentation is organized into Overview, Examples, Webhooks, Endpoints, Objects, and Feedback. Every page has a Copy as Markdown button. Code examples are available in cURL, Node.js, Python, and C#, each with a copy button.

Download the full API description: On the OpenAPI spec page, select Download spec. Your developer can import this file into tools such as Postman. 

Note: If the download doesn't start (common in mobile banking apps), select The download didn't work for me, copy the web address shown, and paste it into your web browser.

Connect your software (Platform API)

On the Platform API tab, follow these steps:

  1. Create an API key. Select Create an API key (or Create another API key if you already have one).
  2. Copy your client ID and a key. Either key works. Store them somewhere secure.
  3. Exchange them for an access token. Follow the API Authentication page. Example code shows how to get a token and list your invoices.

Note: If a key is ever exposed, replace or delete it. See Working with API keys.

Get notified (Webhooks)

On the Webhooks tab, follow these steps:

  1. Set up a secure web address (HTTPS). Your server must accept the message and respond within 10 seconds.
  2. Create a webhook. Select Create a webhook (or Create another webhook).
  3. Send a test event. Confirm your server receives messages from Autobooks.

Test before you go live

Try a Platform API call

  1. On the Platform API tab, select Try it here.
  2. Choose an API key. Keys without the needed permission are greyed out (for example, "missing invoices:read").
  3. Choose an endpoint (the action to test). It starts on List invoices, which needs no extra details.
  4. Fill in any required details. For example, to view one invoice, enter its ID. Create and update actions come with a sample filled in.
  5. Select Run. You'll see exactly what was sent and the response.

Important: Tests that view information use your real account. You'll see your actual invoices, customers, and products.

Tests that create, change, or send are checked but not completed. Nothing in your account changes and no emails are sent.

What your test results mean

Result What it means
Response 200 with data It worked. The data shown is your real data.
Response 200 with { "valid": true } Your request passed every check. Nothing was changed.
Response 400, validationFailed Something in the request needs fixing. Each problem is listed.
Response 404, notFound No record with that ID exists in your account.
Response 429, retry after a number of seconds Too many requests (limit is 1 per second). Wait and try again.
The request didn't complete Check your internet connection and try again.

Send a test webhook

  1. On the Webhooks tab, select Try it here.
  2. Choose a webhook. Webhooks not set up for incoming payments are greyed out.
  3. Select Send. Autobooks sends a sample payment message to your web address.
Result What it means
Your endpoint accepted the event (200 OK) Your server received the test.
Your endpoint rejected the event (reason) Your server responded with an error. Ask your developer to check it.
We couldn't reach your endpoint Nothing responded at that address. Check the address and your server.

Note: Test messages use sample data only. It's not a real payment, and nothing in your account changes.

You can also test from any individual reference page (like List invoices) by selecting Try it here. Select Back to docs to return.

Share your feedback

Tell us what's missing. Go to the Feedback page, describe what you need under What's missing?, and select Send. Your feedback goes directly to our product team.