Create and manage webhooks · BreezeAuth Docs

Webhooks are configured per organization in the BreezeAuth admin console. This page walks you through each step. No programming is needed to configure a webhook, but someone on your side must provide the endpoint URL: the address of the system that will receive the messages.

Before you start

Permissions. You need permission to view and manage webhooks in your organization. If the Webhooks tab is greyed out, or you don’t see the Add webhook button, ask an administrator of your organization.
An endpoint URL. Your developers provide this address, for example https://example.com/webhooks/breezeauth. The endpoint should already be able to verify signatures and acknowledge messages quickly before you enable it in production.
Firewall (optional). If your network team restricts incoming traffic, or if you want to, allow the BreezeAuth IP addresses to reach the endpoint. Requests from those addresses must not be blocked, or deliveries will fail.

Tip: use an https:// URL. BreezeAuth also accepts http://, but then messages travel unencrypted over the internet.

Find the webhooks of your organization

Sign in to the admin console.
In the sidebar, select Organization. The Manage Organization page opens.
Select the Webhooks tab.

The list shows every webhook registered for the organization, with its URL, Status (Enabled or Disabled), subscribed Events and creation date. Select a row to open the webhook’s details.

Create a webhook

On the Webhooks tab, select Add webhook. The New webhook form opens.
Fill in the fields described below.
Select Create webhook.

Field	Description
Name	A label to recognize the webhook, for example “HR system” or “Billing events”. Up to 255 characters. Only you see it.
URL	The address that will receive the messages. Up to 255 characters. Redirects are not followed, so enter the final address (see Delivery and retries).
Events	The events this endpoint receives. Pick only the ones the receiving system needs. See the event catalog. A webhook with no events selected receives nothing.
Enabled	When checked (the default), events are sent. Uncheck it to pause deliveries without losing the configuration.

From then on, every subscribed event in the organization is delivered to the URL within seconds.

Note: each webhook receives its own copy of every event it subscribes to. If two webhooks point to the same URL and subscribe to the same event, that URL receives the event twice, with the same event identifier.

Edit a webhook

Open the webhook from the Webhooks tab.
Select Update.
Change the name, URL, events or the Enabled option, then select Save changes.

Changes take effect immediately, including for retries that are still pending:

If you disable the webhook, or remove an event from its list, pending retries for that webhook or event are cancelled.
If you change the URL, the next attempts go to the new URL.

Pause deliveries

To stop deliveries temporarily, for example during maintenance of the receiving system, edit the webhook and uncheck Enabled. Events that happen while the webhook is disabled are not stored for later: they are simply not sent. When you enable it again, only new events are delivered. Your system can catch up on what it missed by reading the current data from the API (see Receive events reliably).

Delete a webhook

Open the webhook from the Webhooks tab.
Select Delete.
Confirm in the Delete webhook dialog.

Important: deleting a webhook cannot be undone. Deliveries stop immediately and the webhook’s event history is no longer available in the admin console. If you only need to stop deliveries for a while, disable the webhook instead.

Check what was sent

The details page of each webhook shows its Event History: every delivery attempt, whether it succeeded and, if not, why. See Event history.

Changes are audited

Creating, updating and deleting webhooks are recorded in your organization’s Audit Logs, together with who made the change and when.