Reporting Custom Events

This document will help you implement additional Katalys event tracking. These events allow a Brand to report on funnel analytics for their own benefit or to provide insights to Partners. This data can be used to perform funnel depth analysis or optimize media buying.

Quick Start

To report custom events to Katalys, follow these steps:

Document the events you will implement. See below for naming suggestions.
Implement the Katalys Tracking Script. Read Landing Page Tracking for details →
Use the code template below to record the events.

Code Template

After you have implemented the Katalys Tracking Script, you can send events into the script. Follow this template when triggering events:

HTML

<script>_revoffers_track.push("YOUR_EVENT_NAME_HERE")</script>

For example, to trigger an event named “addtocart”, add the following script:

HTML

<script>_revoffers_track.push("addtocart")</script>

These examples assume you have implemented your Katalys Tracking Script, and that the script is executed before the above code runs. If you have not deployed the Katalys Tracking Script, or if your tags are firing out-of-order, you will find JavaScript errors in your console such as Uncaught ReferenceError: _revoffers_track is not defined. Read Landing Page Tracking for details on implementing your Katalys Tracking Script.

Repeat these steps for any additional events you want to track. Notify the Katalys team you’ve finalized the implementation for a Q/A check. You can also read below for edge cases and alternative implementations that might help you build your own tag execution stack appropriate for your website.

Naming Your Events

Decide on what the event name will be and insert it into the highlighted section of the above example script between the quotes. Follow these rules:

Do not use spaces.
Do not use certain terms and names (review the prohibited list below).
Review suggested names below for common use cases.
Review prohibited names below to ensure your integration works correctly.

Suggested Event Names

Below is a list of event names that you might find applicable to your integration.

Event Name	Status	Description
`addtocart`	RECOMMENDED	User added items to their cart. This event is triggered automatically by some Katalys plugins, such as WordPress and Shopify.
`thank_you`	RECOMMENDED	User has completed a pre- or post-sale funnel. This event is triggered automatically by some Katalys plugins, such as WordPress and Shopify.
`email_submit`	RECOMMENDED	User has submitted their email in a pre-sale funnel or in a survey
`survey_begin`	RECOMMENDED	User has entered a dedicated survey or questionnaire

Prohibited Event Names

Please do not use the following event names as it will impact your wider integration. These terms are already reserved for events and actions on the Katalys Platform.

Event Name	Status	Description
`click`	PROHIBITED	Used internally, not available for custom implementations.
`convert`	PROHIBITED	Special case that forces the creation of an order. Cannot be used to generate a custom event.
`nobounce`	PROHIBITED	Used internally to signify a session that did not bounce.
`pageview` or `page_view`	PROHIBITED	These have special meaning inside of Katalys analytics and cannot be used to generate a custom event.

How To View Events

Any event that you trigger will be registered in Reporting.

Navigate to your account’s Reports.
Go to my Reports page ->
Click on the “Columns” button to change your column selection.
Add the columns “Event Name” and “Event Count”.
Ensure that your date-range includes today’s date, if you just triggered the events.

You should see events appearing in Katalys reporting within 30 minutes of triggering them on your website.

Advanced Technical Integrations

Some integrations with Katalys may have placed the Katalys Tracking Script via their own custom implementation and/or might need to trigger events from other systems. Review the details below for additional inspiration on what might best for you.

Need a synchronous script option?

You can create a synchronous script variant of your Katalys Tracking Script. This ensures that _revoffers_track variable is defined immediately and available to receive your custom event. This might be more convenient when using a pixel manager.

In the following example, we’re placing a synchronous JavaScript tag (meaning: does not contain the async property) directly before the Custom Event script. This code can be placed on your website, or inside a tag manager: there is no issues including the script multiple times on your page.

HTML

<script src="https://db.revoffers.com/js/KA-XXXXXXXX.js"></script>
<script>_revoffers_track.push("YOUR_EVENT_NAME_HERE")</script>

Are your scripts firing out of order?

If you using the Katalys WordPress plugin, or are loading the Katalys JavaScript via Google Tag Manager or some other delayed-loading mechanism, you might see Uncaught ReferenceError errors in your browser’s console preventing your events from being recorded.

The following example ensures that _revoffers_track is defined. It can run before or after your Katalys Tracking Script without interrupting normal operation.

HTML

<script>
window._revoffers_track=window._revoffers_track||function(){
var a=[],b=a.push;a.push=()=>b.call(a,arguments);return a}()
</script>
<script>_revoffers_track.push("YOUR_EVENT_NAME_HERE")</script>

When implementing this example, remember that you are still responsible for implementing your Katalys Tracking Script in a separate code snippet in order to record your events into Katalys.