Introduction to Beefree SDK

Welcome to the Beefree SDK technical documentation! This page discusses what Beefree SDK is and outlines resources you can use to get started with integrating our no-code embeddable builders.

What is Beefree SDK?

Beefree SDK is an embeddable no-code builder that gives your end users the freedom to design stunning emails, landing pages, and popups—without writing a single line of code. It’s easy to configure, intuitive to personalize, and built to scale with your needs—whether you're a startup or an enterprise. Built with both developers and end users in mind, it’s designed to integrate easily into your application, scale as your product grows, and provide a flexible, white-label design experience.

For developers, Beefree SDK is easy to work with. You can personalize the design experience by adding simple configuration parameters. Want to enable or disable a feature? Just check a box in the Developer Console, hit save, and the changes are immediately reflected on the frontend. No complicated setup required.

For your end users, Beefree SDK is an intuitive drag-and-drop editor with everything end users need to bring their creative ideas to life—whether they’re creating an email campaign, a landing page, or an attention-grabbing popup. Content blocks like titles, images, lists, tables, buttons, and more are all available right out of the box.

Beefree SDK includes the following features and more:

  • Email builder: A no-code email creation environment that helps end users quickly create beautiful emails. This environment supports your end users in following email creation best practices recommended by industry experts.

  • Page builder: A no-code landing page creation environment that empowers end users to build visually stunning landing pages. They can use a landing page as a link for a call-to-action (CTA) inside emails, to embed forms and capture information, or to create standalone pages.

  • Popup builder: The popup builder is a no-code environment that provides end users with the tools they need to build compelling popups that capture attention.

  • AI-generated templates: With both Simple Schema and the Convert endpoints, you can build a custom AI-generated content creation experience (for assets such as emails, landing pages, or popups) for your end users.

  • AI Writing Assistant: A helpful AI assistant to help end users write their design content.

  • File manager: A tool to manage media assets (images, PDFs, and so on).

  • Template catalog: A design template catalog that integrates industry best practices to support end users in quickly getting across the finish line with their creations and achieving quick design wins.

  • API offering: Extend the functionality of any of the builders with our comprehensive suite of APIs.

This site discusses the technical capabilities of Beefree SDK, and how to embed it into your web application. To learn more about the end user experience, and how your end users will interact with Beefree SDK on the frontend of your application, reference the White Label End User Guide. Markdown files for this guide are available in this GitHub repository, which you can clone and use as a starting point for building a knowledge base for your end users.

Quick Start

Take the following steps to get started with Beefree SDK in a few minutes:

  1. Create an account to access the Developer Console and obtain your credentials.

  2. Create a new subscription to get started. Beefree SDK offers a generous Free plan that includes each builder type mentioned in the previous section.

  3. Create an application and obtain your Client ID and Client Secret.

  4. Clone the beefree-sdk-sample-client repository, which includes the code for email and popup builder implementations.

  5. Add your credentials, the Client ID and Client Secret from step three, inside the placeholders in the code.

  6. Once the email builder, or popup builder, depending on which environment you chose, opens, you can start experimenting with the SDK's configuration by customizing the configuration parameters in the beeConfig section of the code.

  7. You can also customize the SDK's configuration inside the Developer Console under the Application configuration section of the application you created.

Note: Visit the Beefree SDK pricing page for a comprehensive list of features and the plan type they correspond to.

Quick Start Guides

Reference Quick Start Guides specific to your tech stack:

Beefree SDK's Embeddable Builders

Learn more about our three embeddable builders.

File Manager

In addition to our drag-and-drop editors, we also offer a standalone File Manager application, which can be used alongside any of the builders. The File Manager is designed to simplify the organization and management of digital assets. It is an image and document management user interface that can be launched as a standalone application. This allows your customers to quickly upload or manage assets, without having to load one of the builders.

Learn more about our File Manager and File Storage Options.

Developer Essentials

Create a free account and obtain your Client ID and Client Secret in the Developer Console to get started. Set up a local environment to experiment with customizing a configuration. Watch the configuration changes and customizations come to life on the frontend.

Videos

Learn more about Beefree SDK through video tutorials.

Sample Code

Learn more about Beefree SDK through available sample code and example projects in GitHub.

Last updated

Was this helpful?