Webhook Delivery Log, Retries and Disabling

Availability: all plans

When ServiceVisit sends an event to a webhook endpoint, it records what happened. This guide explains how to read that record, how failed deliveries are retried, and how an endpoint ends up switched off, either by you or automatically after repeated failures.

Before you start

You need the role access that allows managing integrations.
Deliveries are picked up in batches roughly every 30 seconds, so allow about that long between an event and its first attempt.

Steps

Read the delivery log

Open Settings, then Integrations, then Manage on the Webhooks card.
On the endpoint's row, choose the list icon (tooltip "Delivery log").
The Webhook Delivery Log page shows the most recent 50 attempts, newest first. Columns are Event, Status, Attempts, Last attempt, HTTP status and Response.
Status values are Succeeded, Failed (it will be tried again), and DeadLettered (all tries are used up, so ServiceVisit has stopped trying). Pending items that have not been tried yet appear with a plain grey badge.
HTTP status is the answer the receiving system returned. Response is the start of what it said back, which often explains a rejection. Hover over it to see the full text.
If the page says "No deliveries yet", trigger an event or send a test event from the list.
Choose Back to webhooks to return.

Understand retries

Each attempt either succeeds or fails. A failure that can be retried is tried again after a wait that doubles each time: about 2 minutes after the first failure, then about 4 minutes after the second.
The endpoint's Max retries setting under Advanced delivery settings on the edit page is the total number of attempts allowed. A new endpoint allows 3. When the attempts are used up, or the failure is not one that can be retried, the delivery is marked DeadLettered and is not sent again.
Timeout (seconds) is how long ServiceVisit waits for the receiving system to answer. A new endpoint waits 30 seconds.

Disabling

Auto-disable after on the same panel sets how many failures in a row switch the endpoint off. A new endpoint uses 10. A success resets the count to zero.
On the list, an endpoint with recent failures shows a yellow badge such as "3 failing". An endpoint that has been switched off shows Disabled.
To switch an endpoint off yourself, open it with the pencil icon, untick Active, and choose Save Changes. Tick Active again to turn it back on.
To remove an endpoint, use the trash icon (tooltip "Delete") and confirm. The message warns that it stops receiving events immediately.

Tips

A growing "failing" count means the receiving system is down, slow or rejecting messages. Open the delivery log first and read the HTTP status and response before changing anything.
After you fix the receiving system, use Send test event from the list and check the log shows Succeeded.
A disabled endpoint receives no new events and does not send queued ones. Turn Active back on before testing again.
The Last delivery column on the list shows the time of the last success, or the time of the last failure when there has been no success, or "Never delivered".
Changing the signing secret or the endpoint address does not clear the failing count. Only a successful delivery does.

If something goes wrong

If the page says "Unable to load delivery history." or "Unable to load webhook endpoints at this time.", refresh the page. If it continues, contact support.
If every attempt shows a rejected signature response from the receiving system, the secret there is out of date. See the signing secret guide.
If an endpoint turned itself off, find out why in the delivery log, fix the cause, then tick Active on the edit page.
If a test event queued but nothing appears in the log after a minute or so, refresh the Delivery Log page.

Creating a Webhook Endpoint — A webhook is a way for ServiceVisit to tell another system when something happens in your account. You register an endpoint, which is the address of the receiving system, and ServiceVisit sends it a…
Webhook Events and the Signing Secret — Every webhook endpoint listens for a set of events, and every message it receives is signed with a secret that only you and the receiving system know. This guide covers choosing which events an…
Manage integrations — ServiceVisit has an Integrations page under Settings where you connect ServiceVisit to other systems. It has two parts.
Accounting integration with QuickBooks Online and Xero — The accounting integration sends your ServiceVisit invoices, payments, refunds, customer credits and approved technician time to your accounting system, so your bookkeeper does not retype them. It…