Receive Custom Events from Bonomi (soon :)

From July 2022 you can provide a webhook endpoint to listen to custom events in Bonomi.

A webhook enables Bonomi to push real-time notifications to your app. Bonomi uses HTTPS to send these notifications to your app as a JSON payload. You can then use these notifications to execute actions in your backend.

Steps to receive webhooks

You can start receiving event notifications in your app in a few steps:

1. Identify the events you want to monitor and the event payloads to parse.

2. Create a webhook endpoint as an HTTP endpoint (URL) on your server.

3. Handle requests from Bonomi by parsing each event object and returning 2xx response status codes.

4. Test that your webhook endpoint is working properly.

5. Deploy your webhook endpoint so it’s a publicly accessible HTTPS URL.

6. Provide your publicly accessible HTTPS URL to Bonomi.

What is a webhook endpoint

Creating a webhook endpoint is no different from creating any other page on your website. It’s an HTTP or HTTPS endpoint on your server with a URL. If you’re still developing your endpoint on your local machine, it can be HTTP. After it’s publicly accessible, it must be HTTPS. You can use one endpoint to handle several different event types at once, or set up individual endpoints for specific events.