Introduction

The WillSuite Webhooks can let your integrations take an action in response to events that occur on WillSuite.

Just getting started?

To gain access to the WillSuite webhooks, you'll need to be a paying user of our software. While most requirements can be met using the software's existing features, there might be occasions where additional customisation is necessary. If you find yourself in need of further customisation, please get in touch with our support team via email, phone, or through our website ​. Our team will then assist you by providing the webhooks access and any additional help you may require.

About webhooks

Webhooks allow you to get real-time updates from a software system by automatically sending data to your server whenever certain events occur.

Unlike polling an API, where you repeatedly check for new data, webhooks send you the data as soon as it’s available. You simply set up the webhook once to specify the events you're interested in.

About webhooks on WillSuite

When you create a webhook, you provide a URL and choose the events you want to track on WillSuite. Whenever one of these events happens, WillSuite sends an HTTP request with event details to the URL you specified. If your server is configured to handle webhook requests at that URL, it can respond appropriately when it receives the data.

Choosing webhooks or the REST API

Using webhooks has the following advantages over using the API:

• Webhooks require less effort and less resources than polling an API.
• Webhooks scale better than API calls. If you need to monitor many resources, calling the API for each resource may cause you to hit your API rate limit quota quickly. Instead, you can subscribe to multiple webhook events and receive information only when an event happens.
• Webhooks allow near real-time updates, since webhooks are triggered when an event happens.

If you only need information once or intermittently, or only want to get information from a small set of resources with no plans to scale up, you can call the API when you need the relevant information.

Creating webhooks

Once you have the necessary access on WillSuite, you'll find a Webhooks option in the side navigation under company settings.

You can create multiple webhooks based on your needs and the events you want to monitor. You'll need to specify an endpoint that will be triggered whenever the selected events occur on WillSuite. It's important to ensure this endpoint is always accessible and doesn't require authorisation. For added security, you can include a unique key in the URL parameters to verify that the endpoint is called by WillSuite.

Request

Once an event has been triggered WillSuite will use a POST HTTP method to call your endpoint, it is critical to ensure you endpoint allows POST requests. All post request will contain webhook_type in the payload along with relevant data of that event.

Request Response

Once you capture the event, WillSuite expects a 202 status code indicating to us the endpoint was correct.

INFO

202 status code indicates the request has been accepted for processing, but the processing has not been finished yet.