Overview

Listen to Beam events on your webhook endpoint so your integration can automatically trigger reactions.

Why use webhooks

When building integrations, you might want your applications to receive events as they occur in your Beam account, so that your backend systems can execute actions accordingly.

To enable webhook events, you need to register webhook endpoints. After you register them, Beam can push real-time event data to your application’s webhook endpoint when events happen in your Beam account. Beam uses HTTPS to send webhook events to your app as a JSON payload that includes an Event object.

Receiving webhook events is particularly useful for listening to asynchronous events such as when a customer’s bank confirms a payment, a customer's deposit had been approved and can be moved off-chain, a customer's onboarding has been approved, or when wallet addresses have been assigned to the customer.

Event overview

Beam generates event data that we can send you to inform you of activity in your account.

When an event occurs, Beam generates a new Event object. A single API request might result in the creation of multiple events. For example, if you create a new account for a customer, you receive User.Onboarding.Submitted and User.Onboarding.Approved events.

By registering webhook endpoints in your Beam account, you enable Beam to automatically send Event objects as part of POST requests to the registered webhook endpoint hosted by your application. After your webhook endpoint receives the Event, your app can run backend actions (for example, saving a user's payment information after you receive a Beam.Payment.Completed event).

Event object

The Event object we send to your webhook endpoint provides a snapshot of the object that changed.

See the full list of event types (Individuals or Business) that we send to your webhook.

{
    id: '3454444-444444-4444-4443f344,
    eventName: 'Beam.Deposit.Detected',
    createdAt: '2023-07-11 18:58:53.325-0500',
    resources: ['accounts/e90751ef-273f-46f5-bb5f-93e3e18a0d35/deposits/7c2fc3c4-dd14-44a6-83e7-99b25e8d1710'],
}