Getting Started
The Beam SDK consists of two parts: the storefront components and the OMS integration. Both of these are needed to fully completely integrate the Beam SDK with your site.
The storefront components integrate easily into your site and provide the customer with an interactive experience. The customer can choose a nonprofit that the brand will support and follow along with the brand's impact.
The OMS integration is a suite of APIs you can call from your OMS to securely verify order value, update order cancellations and modifications as well as register recurring subscriptions.
The storefront components and OMS integration work together to track all the impact made by your community as well as measure conversion, AOV and repeat order rate to showcase Beam's ROI impact in our Partner Portal for your team. Donations are made by the brand in aggregate quarterly via the Partner Portal. No payments or donations are made via the SDK.
Check out the Other Integrations tab to learn how we can integrate throughout your marketing stack via triggered emails, texts, A/B tests and more.
Storefront Components
Beam provides storefront components ("widgets") to embed into various parts of the customer flow. The look and feel of the widgets is customizable to match the parent site. Beam will pre-style all of the widgets to your liking so your dev team doesn't need to do any styling.
Under the hood, the widgets send data to and from Beam APIs, which can use information such as the location of the customer or items in the cart to display relevant nonprofits, promotions, and personal and community impact.
In addition to the core SDK, Beam provides prebuilt integrations for popular platforms like Shopify and Salesforce which simplify implementation. These docs also include integration guides for other platforms like BigCommerce.
Beam widgets can be added to your site either by loading scripts from the Beam CDN (sdk.beamimpact.com) or by installing the Beam NPM package, if you have a custom storefront.
OMS Integration
Beam offers a suite of APIs to handle recurring orders (subscriptions), track order cancellations and modifications, and securely verify order value. These APIs use a different API key than the front end storefront widgets.
For Shopify + Salesforce OMS, Beam offers a custom app to handle OMS updates for your team.
See OMS Integrations for more information.
Other Integrations
Do you want to connect with your customers using Beam across your marketing channels? Beam integrates across your marketing stack, from email service providers to A/B tests. See Other Integrations for more information.