Getting Started

1. Get one or more Pyze App Keys

See instructions to get one or more Pyze App Keys.

2. Setup & Initialize

Setup & Initialize Pyze in your Roku app

Build and Go!

You have enabled all screen flow funnels, loyalty, cohort and churn analysis, Intelligence data explorations, built-in events, auto segmentation, and much more. Use your app with the Pyze SDK and you should see data on

In the following sections, you can add app-defined-, timed- and curated- events. To reach out to your users and create meaningful relationships, add push and in-app notifications.

3. Add events

Add Events to your Roku app.

A comprehensive overview of curated, app defined, timed and built-in events is available.

Get Pyze App Keys

Get a Pyze App Key (PAK) for each Roku app created.

1. Login to

Every app is uniquely assigned a Pyze App Key (PAK), a 22 character app specific key, which you obtain from after logging in with your email and password. If you have not signed up for Pyze, you can Get Pyze here first.

Login to

2. Add a new app

  • To add an application to the Pyze platform, begin by selecting Settings from the Navigation Pane.
  • Under the Apps Tab, click the Add App+ button at the top right of the window.
  • Enter the App Name and Appstore URL (if available), Platform (iOS, Android, Web/SaaS, tvOS, watchOS) and select your Timezone.

4. Copy Your Pyze App Key

Once you add your new app, refresh the page. Navigate to your newly added app’s settings by selecting the app from the drop-down list. The Pyze App Key will be displayed below to the right (DmPTFdslRjObk1-ZlXQDVQ in this example). Copy Pyze App Key.

Setup & Initialize

a. Copy pyze-task.brs and pyze-task.xml into `components` directory
b. Copy pyze-roku.brs into source directory

user following api inside Main.brs file to initialize Pyze SDK

pyze = PyzeRokuLib(m)

Build and Go!

Add Events

See a detailed Events Overview here.

Pyze has made it easy for you to capture events. We support custom and timed events.

Custom Event Handling

We support custom events that can be used to track any event within the web app and can be called with or without attributes. See postCustomEvent and postCustomEventWithAttributes method in the Pyze class (See here).

//Get the Pyze reference
pyze = PyzeRokuLib(m)
//Post custom event

//Pyze send event with custom attributes
pyze = PyzeRokuLib(m)
attributes = {

In-App Notifications

Enable In-app Notifications in your App

In-app notifications allow app businesses to reach out to app users when they use your app. In-App Notifications are deeply integrated in Pyze Growth Intelligence and allow app businesses to reach out to users from manually from Dynamic Funnels and Intelligence Explorer, and automatically based on workflows and campaigns from Growth Automation.

App businesses have full control over when to display the in-app messages and have two options: use the user interface provided by Pyze or develop their own.

Option 1. Use Pyze provided user interface

Invoke built-in User Interface either on button click, in your onLaunch method

Invoke UI from your app

Call the following method, whenever you want to show notification with default pyze UI. Method accepts a callback handler method which will be invoked whenever any of the call to action button on the UI is pressed.

- Pyze show in-app message
//To show inapp message from your Screen, import the pyze source file first.
<script type = "text/brightscript" uri = "pkg:/source/pyze-roku.brs" />
//import the pyze reference and then call the show in app message api.
pyze = PyzeRokuLib(m)