Hooks
Register webhook endpoint URLs and subscribe to the events you want them to receive.
A Hook is a webhook endpoint registration. Each Hook is one URL plus the list of event types that URL should receive. When a subscribed event fires anywhere on your account, BEEM POSTs the event payload to the registered URL.
This page covers how to add and manage Hooks. The event payloads themselves are documented on Payment Link Webhooks and Channel Webhooks.
How Hooks work
Each Hook stores:
- Type — the delivery method. Currently only
WEB(HTTPSPOSTto the URL you specify). - URL — the endpoint that will receive event payloads.
- Event codes — the list of event types this Hook subscribes to.
You can register multiple Hooks. Different Hooks can subscribe to different event sets — useful if you want to route Payment Link events to one service and Channel events to another, for example.
Add a Hook in the Portal
- Sign in to the Account Portal.
- Go to Integrations → Hooks in the left navigation.
- Click + Create a hook in the top right. The Add a hook dialog opens.
The Add a hook dialog. Type, Webhook URL, and the events to subscribe.
- Complete the form:
| Field | Description |
|---|---|
| Type | The delivery type. Currently only WEB — HTTPS POST to the URL you specify. |
| Webhook URL | The endpoint that will receive event payloads. Must be a publicly reachable HTTPS URL. |
| Events to subscribe | Pick the event types this Hook should receive. Multi-select. See Payment Link Webhooks and Channel Webhooks for what each event means. |
- Click Add. The Hook appears on the Hooks list and starts receiving events from the next matching event onwards.
Manage existing Hooks
The Hooks list shows every Hook registered on your account.
The Hooks list. Each row is one registered URL and its subscribed events.
| Column | What it shows |
|---|---|
| Url | The endpoint receiving events. |
| Type | Always WEB — the only supported type today. |
| Event Codes | The list of event types subscribed. Click the EVENT CODES badge on a row to expand the full list. |
| Actions | The eye icon opens the Hook's details. The trash icon deletes the Hook — deliveries stop immediately for that URL. |