Skip to main content

Webhook Subscriber

Webhook subscribers represent a destination URL where Odus will send webhook events for the events you subscribe to. You can create multiple webhook subscribers to send events to different URLs based on your application's needs.

Creating a Webhook Subscriber

When creating a new webhook subscriber, you must provide the following information:

  • Recipient URL: the URL where the webhook events will be sent. This should be an endpoint on your server that is publicly accessible and can handle incoming POST requests.
  • Subscribed Events: a list of events that you want to subscribe to. You can select multiple events, and you can change this list later if needed.
tip

For local development, you can use tools like ngrok to expose your local server to the internet and provide a public URL for the webhook subscriber.

After the webhook subscriber is created, you will be provided with a Shared Secret. This key is used to verify the authenticity of the webhook events sent to your endpoint. You should store this key securely and use it to validate incoming requests, it is only shown once during the creation of the webhook subscriber.

More on handling webhooks can be found in the Webhooks guide.