Creating webhooks
Webhooks let you register an endpoint with us so we can push live updates when a new review is posted for your firm. You can then use that information however you wish.
The webhook payload currently carries basic review information only. See Events and payloads for the exact shape.
Register your endpoint
Register it in your dashboard as below, or over the API with Register a webhook. Both manage the same webhooks.
Open API Settings
Go to your Admin Dashboard and click API Settings in the sidebar menu, then open the Webhooks tab and click Register webhook. You need a company admin account.
Set the URL
In the URL field, enter the address we should call, for example
https://example.com/webhook-listener. It must start with https:// or http://, be
reachable from the public internet and accept a POST request.
Choose the event
Under Event, select New review, or New Client Assist enquiry if your firm has Client Assist. You can register one webhook per event.
Register
Click Register. The webhook appears in the list as Active, and deliveries start from the next review posted for your firm. Use Edit on its row to change the URL, or Remove to stop deliveries.
Handling deliveries
We POST the review to your URL as JSON. A few things worth building in:
- Respond quickly with a success status. Anything else counts as a failed delivery.
- Expect no retry. A delivery that fails is logged on our side and dropped, not retried,
so a webhook you miss is gone. Reconcile with
GET /api/v2/reviewsif you need to be certain you have everything. - Do not treat the call as authenticated. The request carries no signature or secret, so
do not act on it as proof of origin. Use the review
idto fetch the review over the API before doing anything sensitive with it. - Keep the URL stable. If the endpoint moves, update it with Edit in API Settings before the old one stops responding.