Custom AddOns

  1. Introduction
  2. Example of a Custom AddOn
  3. Availability
  4. Getting started

Introduction

A Custom AddOn is an addon that you typically developed for your own use.

Partner AddOns start as Custom AddOns, but are then published to the Partner AddOn Directory, becoming available to all applications that have embedded BEE.

Most Custom AddOns do not become Partner AddOns and therefore are not published to the Directory. That’s because, in most cases, you create a Custom AddOn to satisfy a use case that is specific to your application.

An example to clarify what we mean.

Example of a Custom AddOn

Let’s say you embedded our email editor in your event engagement platform, which has a feature that allows event marketers to insert an event ticket’s QR code in marketing campaigns sent to create more engagement around an event.

  • You want those marketers, users of your platform, to be able to easily include a QR code in the emails they send to remind people about the event. That way ticket holders can use the QR code to quickly get into the event venue.
  • So you decide to create a “QR Code” addon: “QR Code” becomes a new tile in the Content tab in the editor.
  • Marketers drag and drop the tile, click on Select event to indicate which event the QR is for, and use the editor to style that section of the message (e.g. size, padding, etc.).
  • The QR code is created dynamically by your platform, at the time the email is sent to a ticket buyer.
  • The feature is specific to your application.

Availability

Custom AddOns are an advanced feature. As a result, the feature is available on the following plans:

  • Gold
  • Enterprise

Of course, there are exceptions to this requirement.

  • Testing: if you are not yet on a Gold or Enterprise plan, and you want to test building a Custom AddOn:
    • Create a development application, as shown here.
    • Request an upgrade to the Gold plan.
    • Test as much as you want. If and when you decide that you wish to deploy your Custom AddOn in production, we will ask you to upgrade your production application to the Gold or Enterprise plan.
  • Development of a Partner AddOn:

Getting started

Log into the BEE Plugin Developer Portal and locate any application that is on the Gold or Enterprise plans. Click on Details to navigate to the application details page. In the lower part of the page, locate the Application configuration section and click on AddOns.

Adding a Custom AddOn

You will be taken to a page that lists the addons that have been installed for this application. Since you are just getting started, the list is likely empty. Click on Create a custom addon to start the process of creating a Custom AddOn.

Refer to the AddOn Development documentation for all the details on building your addon.