Events
Complete catalogue of webhook events your Hooks can subscribe to.
This page lists every event a Hook can subscribe to. Each event is shown with the source it belongs to and a one-line summary of what triggers it. For the full payload shape and the order events fire in for a given scenario, follow the link in the Payload column.
Approval events
Source: approval. Lifecycle events for approval requests on outbound payouts.
| Event | When it fires | Payload |
|---|---|---|
layer1:approval:request:vote-required | An approval request needs a vote from an approver. Lets an approver-facing integration surface a "you need to act" prompt. | See Approvals |
layer1:approval:request:status-changed | An approval record's status transitioned (Pending → Approved / Rejected / Expired). | See Approvals |
Payment events — checkout (Payment Links)
Source: payment. Lifecycle events for Payment Link In and Payment Link Out.
| Event | When it fires | Payload |
|---|---|---|
layer1:payment:checkout:status-change | The payment's status field transitioned (e.g. PENDING → PROCESSING → COMPLETE). | Payment Link Webhooks |
layer1:payment:checkout:transaction-detected | An inbound transaction was seen on-chain but has not yet reached the required number of confirmations. IN only. | Payment Link Webhooks |
layer1:payment:checkout:transaction-confirmed | The inbound transaction reached the required confirmations and funds were credited. IN only. | Payment Link Webhooks |
layer1:payment:checkout:transaction-held | The payment was placed on hold for compliance screening. Fires for both KYT (Chainalysis) flags and Travel Rule RFIs — call GET /platform/v1/travel-rule-rfis to determine which. See Building a Travel Rule Integration. | Payment Link Webhooks |
layer1:payment:checkout:transaction-late | Funds arrived for a payment already in a terminal state (COMPLETE, UNDERPAID, or EXPIRED). IN only. | Payment Link Webhooks |
layer1:payment:checkout:transaction-settled | The payment has been settled — fires alongside the move to COMPLETE. | Payment Link Webhooks |
layer1:payment:checkout:refund-initiated | A refund has been initiated for a payment via BEEM's auto-refund feature. | Auto Refunds |
Payment events — channel
Source: payment. Lifecycle events for channel deposits.
| Event | When it fires | Payload |
|---|---|---|
layer1:payment:channel:transaction-detected | A channel deposit appeared on-chain but has not yet reached the required confirmations. | Channel Webhooks |
layer1:payment:channel:transaction-screening-requested | A channel deposit was submitted to compliance screening. Always fires — the deposit then either moves to transaction-held (if screening flags it) or proceeds to its next status. | Channel Webhooks |
layer1:payment:channel:transaction-held | A channel deposit was held by compliance screening. Funds are not credited until the hold clears. Fires for both KYT (Chainalysis) flags and Travel Rule RFIs — call GET /platform/v1/travel-rule-rfis to determine which. See Building a Travel Rule Integration. | Channel Webhooks |
layer1:payment:channel:transaction-confirmed | A channel deposit reached the required confirmations; funds credited to the linked wallet. | Channel Webhooks |
layer1:payment:channel:transaction-rejected | A channel deposit was rejected. Terminal. Funds are typically returned to the sender, though the exact outcome is compliance-dependent. | Channel Webhooks |
Ledger events
Source: ledger. Events for asynchronous report generation.
| Event | When it fires | Payload |
|---|---|---|
layer1:ledger:report:ready | A balance or transaction report you requested from the Exports menu has finished generating and is ready to download. | Exports |