API Events

Last updated 06/27/2022

API events correspond to a specific user action, and can be used to gauge user engagement from your website. With Bread & Butter IO, you can use custom API events to define and monitor your customers’ user journey across your website. Custom events let you gain insight into the most effective way to encourage customer conversion.

For example, you can create an API event for every user who clicks on a “Free Trial” button. Then, you can filter by this event on the Bread & Butter IO Dashboard to see which users are interested in a trial. You can also add a custom event for user sign-up, and filter by both events to see who signed up after a trial.

You can create as many API events as you need, with unlimited combinations to really see what your users are doing on your website.

Creating an API Event

Define your API Events in Bread & Butter IO by following these steps:

  1. Log in to your Bread & Butter IO Dashboard.

    https://app.breadbutter.io/sign-in/

  2. From the Logic tab in the left menu, go to API Events.
  1. Click Create New.

  2. Choose an Event Color and enter an Event Display Name. Note that the event will be displayed on your Bread & Butter IO Dashboard with the selected colour and event name.
  1. Enter an Event Code. This must be unique, and can’t have any spaces. This code is used by your website to create the event.

  2. Enter an Event Description, which describes the purpose of your event.

Your custom API event appears in the list under API Events and is now ready to be used. Make a note of the Event Display Name and Event Code.

Please note that you can disable an event by unchecking it. Events need to be enabled (checked) to be used by your website.

Managing API Events

You can manage your API events in three ways:

  • Disable an API event by unchecking it in the list. Events must be enabled (checked) to be used by your website.
  • Edit an event by hovering over the event and clicking the Edit (pencil) icon.
  • Delete the event by hovering over the event and clicking the Delete (trashcan) icon.

Using an API Event