Skip to Content
Using webhooksGETList webhooks

List webhooks

GET/api/v2/webhooks

Returns every active webhook registered for your firm, whether it was registered over the API or in API Settings in your dashboard. The list is not paginated: your firm can have at most one webhook per event.

Request

GET /api/v2/webhooks
curl --location 'https://www.reviewsolicitors.co.uk/api/v2/webhooks' \ --header 'Authorization: Bearer {access_token}'

Response

200 OK
[ { "id": 399, "url": "https://example.com/reviewsolicitors", "eventType": "NEW_REVIEW", "status": "ACTIVE" } ]

A firm with no webhooks gets an empty list, [].

The webhook object

FieldTypeDescription
idnumberThe webhook’s unique id. Use it to update or delete the webhook.
urlstringThe address we send events to.
eventTypestringThe event the webhook receives. See Events and payloads.
statusstringACTIVE for every webhook returned. Deleted webhooks are not listed.