Creating webhooks

This page explains how to set up a webhook, to send requests to your server which will handle these events.

Finding your payload URL

To set up a webhook, you'll need to tell us where to send events. This endpoint should use HTTPS.

The fastest way to get started is with a service that provides an endpoint to process webhooks for you. Even if you eventually plan on creating a custom integration, this will allow you to validate you can receive webhooks correctly, before you start to develop on your machine or connect to your server.

Webhook.site shows you webhooks it receives. The Your unique URL field is your payload URL. This is useful for understanding what you will receive and debugging connections.

Zapier allows you to build workflows based on webhooks. This is a low-code way to build workflows that integrate with different tools.

The services mentioned above are not affiliated with us, nor do we make any guarantees regarding their security. If you expect your webhook payloads to be sensitive you should do appropriate due diligence on the services you use.

Configuring your webhook in the Hypertune UI

To set up a webhook connection, go to the Settings view in your project. Scroll down to the Webhooks section and click New webhook.

Webhook name

This is just to help you organise your webhooks, in case you're setting up multiple on your project. It doesn't affect webhook delivery.

Payload URL

This should be set to the payload URL you found above. Make sure it starts with https:// and is publicly resolvable and reachable.

Secret

This secret allows you to verify that requests sent to your endpoint are genuine. We'll generate a secret for you, but you can set your own. It should be set to a cryptographically secure randomly generated string.

Active

This is a toggle that allows you to activate or deactivate webhook subscriptions. Webhooks will receive events only if they are active.

Last updated