Working with webhooks

A webhook lets Autobooks notify your business software automatically when something happens in your account, so your developer doesn't have to keep checking for updates. For example when a customer initiates a payment, Autobooks can alert your order system so it starts processing the order.

Each webhook sends notifications to one web address (called an endpoint) that your developer sets up. Right now, Autobooks sends one type of notification: Payment incoming, which is sent when a customer initiates a payment to you.

Only the primary administrator can create and manage webhooks. If a developer is setting up the connection for you, ask them for the web address to use before you start.

View your webhooks

Go to Developer > Webhooks. You'll see a list of your webhooks, each with its web address, the notifications it receives, and the date it was created. Select a webhook to open its details.

If you haven't created a webhook yet, you'll see Subscribe to events, with an example of what Autobooks sends and a Create a webhook button.

Create a webhook

1. Go to Developer > Webhooks and select Create a webhook.
2. Name the webhook. A name is required.
3. Add a description (optional). Note which system receives these notifications.
4. Enter the endpoint URL. The field already starts with https://, so enter only the rest (for example, example.com/autobooks/events). If you paste a full address that starts with https://, Autobooks removes the extra prefix for you.
5. Add headers (optional). If your developer gives you header details, select Add header and enter the Header name and Value. To remove a header, select the trash icon.
6. Send a test event. Select Send a test event to make sure the address works before you save. The result appears next to the button.
7. Choose notifications. Payment incoming is selected by default. You can change this at any time.
8. Select Create webhook.

Note: Web addresses must start with https:// (the secure version). If the address isn't valid, you'll see "Enter a host and path, like example.com/autobooks/events."

What your test results mean

Your webhook is ready

After you create a webhook, a confirmation window opens with your webhook's name (for example, Order fulfillment is ready). It shows a Signing public key. Your developer can use this key to confirm that notifications really come from Autobooks. Using it is optional, but recommended.

From here you can send a test event or select Open Getting started for setup instructions. Select Done to close the window.

Note: You don't need to save the signing public key now. It isn't secret, and you can find it later on the webhook's details page.

Edit a webhook

Select a webhook from the list to open its details page. You can change the name, description, endpoint URL, headers, and notifications. The signing public key appears at the bottom.

To check changes before saving, select Send a test event. It uses the address and headers currently on screen, even if you haven't saved them yet.

Select Save changes to save, or Cancel to go back without saving.

Delete a webhook

1. Open the webhook and select Delete this webhook.
2. In the confirmation window, select Delete webhook. To keep the webhook, select No.

Important: Autobooks stops sending notifications to that address immediately. This can't be undone.

How notifications are delivered

Share these details with your developer:

• A notification counts as received when your server responds successfully within 10 seconds.
• If a notification fails Autobooks tries up to three more times, then stops.
• The same notification can arrive more than once, so your software should be built to handle duplicates.

Tip: If your software misses a payment notification, the payment is still recorded in Autobooks. You can always find it on your Payments list.