Skip to main content
You can register webhooks in the business portal or through the gateway API. The portal is the easiest way to register several event types at once; the API is useful for automation.

​
Register in the business portal

1

Open Webhooks

Sign in to the business portal, open the Settings menu, and choose Webhooks.
The business portal Settings dropdown menu with the Webhooks item highlighted.

Settings menu with Webhooks selected.

2

Start a registration

On the Webhooks page, select Register webhook. Before any endpoint is registered, the page shows an empty state.
The Webhooks page empty state, reading No webhooks yet, with a Register webhook button.

The Webhooks page before any endpoint is registered.

3

Enter the endpoint and events

Enter the Endpoint URL and select the Event types to send to it. Events that already have a registration are disabled here; edit or disable the existing webhook to change them.
The Register webhook dialog with an endpoint URL entered and several payment intent event types selected via checkboxes.

The Register webhook dialog with an endpoint URL and event types selected.

Select Register. The portal creates one registration per selected event type.
4

Review your registrations

Registered webhooks are listed with their Event, Endpoint URL, Status, and timestamps. From here you can send a test event, edit, disable, or view details.
The Webhooks page listing several registered webhooks, each with an event name, endpoint URL, an Active status, created and updated timestamps, and per-row actions.

The Webhooks page listing registered endpoints.

​
One registration per event type

There is exactly one active registration per association and event type. Registering a type that already has one is rejected. To point an event at a different URL, edit or disable the existing registration first.
Disabling a webhook is permanent. The registration is deactivated and retained but cannot be reactivated. To receive that event type again, register a fresh webhook.

​
Send a test event

The portal can send a test event to an active registration, so you can confirm your endpoint receives and acknowledges deliveries before relying on real traffic.

​
Register through the API

The gateway exposes the same registrations. Each call registers or affects one event type. All requests require the standard authentication headers.
  • POST /v1/webhooks registers one event type for a url and returns 201 with the new id. A duplicate type returns 409.
  • GET /v1/webhooks lists registrations; GET /v1/webhooks/{webhookId} returns one.
  • DELETE /v1/webhooks/{webhookId} deactivates a registration (204) and, like the portal, cannot be undone.
See the API reference for the full contracts, and Events for the values type accepts.

​
Endpoint requirements

  • Use HTTPS in production and be publicly reachable by Zeam. Plain http is tolerated in the sandbox only.
  • Respond quickly with a 2xx, then hand processing to a background worker.
  • Expect retries and possible duplicate deliveries; handle them idempotently.
  • Reconcile by identifier rather than delivery order. See Security.