Skip to main content

Using the Event Builder

Abstract

Explains how to use the Event Builder in the Customer Engagement Console (CEC).

The Event Builder uses a GUI to teach developers how to properly build different events and push them to Discover. It also provides live responses, giving real-time feedback on event object formatting.

The Event Builder is separated into three panes, each representing one of the following three tools:

The Builder panel is located in the left-hand side of the Event Builder. You can use it to construct events using different options.

You must make choices for the following options:

  • API - The API section of the Builder panel contains two options: rfk.push() and REST API. You can create events for use with runtime JavaScript by choosing the rfk.push() option or you can create events for use with REST APIs by choosing the REST API option.

  • EVENT - The EVENT section of the Builder panel contains two options: Widget and Non-Widget. You can create widget interaction events such as click and appear by choosing the Widget option. You can create funnel, cart status, and user login events by choosing the Non-Widget option.

    Tip

    More information about types of events can be found in Event Specifications.

Subsequent choices and required input depend upon your choices for these two options. For example, if you choose to create a widget event, you are prompted to supply values for PAGE and WIDGET. On the other hand, if you choose to create a non-widget event, you are prompted to CHOOSE EVENT TO TRACK and to supply the EVENT NAME.

Tip

When you create an event object for the REST API, the following values are auto-completed: t, t0, and uuid.

When you have filled out all of the required information, click Build. Your event is displayed in the Request panel in JSON format.

The Request panel, located in the center of the Event Builder page, displays the event created in Builder in JSON format, along with any messages about missing or auto-completed values.

You can copy the request as cURL or a data object by clicking Copy to Clipboard as...

You can click Validate to test your request object.

Alternatively, you can extract an event from the Event Monitor that is causing an error and paste it into the Request panel, then click Validate. This can help you debug and understand how to fix the error.

The JSON response to your request, along with the status code and any errors are displayed in this panel, located on the right-hand side of the page.

To export the response, click Copy to Clipboard as..., then Copy as data object.