Managing webhooks in your application

When the webhook event occurs, such as when an appointment is created, a POST request is sent to the webhook’s URL. Your application receives data about the event and can act accordingly.

How a webhook works

A webhook returns the same information as a GET request made to the API. The webhook will always send a request with the POST method and with the information about the created object in the body.

For example, let’s say an appointment has been created and there is a webhook for appointment creation. In this case, the webhook will send a POST request as if it were a response to the endpoint for retrieving an appointment, only that Koibox sends it automatically when a new appointment is created.

Tip

The documentation has a section for webhooks; you can review the body of the example in the appointment created webhook.

Responding to the webhook

Once you receive the webhook in your application, you can respond immediately to the request, you can give an empty response with any status code. This response will not be processed by Koibox, so it will not prevent any action by the user in case of error.