Skip to content

Navigation deep links in Braze Pilot

Braze Pilot supports deep linking from Braze messaging to particular parts of the Pilot app. This allows you to create engagement use cases, driving users into various parts of the Pilot application. You can also use optional deep link parameters to customize the content on particular pages in the app for the user. For more on deep linking, see Deep linking to in-app content.

General

These are the deep links for the main navigation pages in the Pilot app.

Steppington

These are the deep links for the Steppington fictional brand app in Pilot.

braze-pilot://navigation/steppington/workout?title=Running&icon=HEART_DETAILS&image=https://picsum.photos/400&info=This%20workout%20is%20awesome%21&workout=5k%20Run&calories=600&length=25&workout_info_left_text=Road%20Run&workout_info_left_icon=RUNNING_HOME&workout_info_center_text=120%20BPM&workout_info_center_icon=HEART_DETAILS&workout_info_right_text=25%3A00&workout_info_right_icon=TIMER_DETAILS

Accepted parameters

Parameter Description Required Default (if not specified) Type Example
title The title to be used at the top of the screen. Yes String Running
icon A string representing which icon to use. No RUNNING_HOME String HEART_DETAILS
image The URL of the image of the item. Yes String https://picsum.photos/400
info Information about the workout to be placed over the workout start button. Yes String This%20workout%20is%20awesome%21
workout The name of the workout. Sent in the st_completed_class event. Yes Number 5k%20Run
calories The number of calories to be shown on the active workout screen. Sent in the st_completed_class event. No Random number between 500 and 1,250 Number 600
length The length of the workout. Sent in the st_completed_class event. No Number 25
workout_info_left_text The text to be used in the left card on the active workout screen. No String Road%20Run
workout_info_left_icon The icon to be used in the left card on the active workout screen. No String RUNNING_HOME
workout_info_center_text The text to be used in the center card on the active workout screen. No String 120%20BPM
workout_info_center_icon The icon to be used in the center card on the active workout screen. No String HEART_DETAILS
workout_info_right_text The text to be used in the right card on the active workout screen. No String 25%3A00
workout_info_right_icon The icon to be used in the right card on the active workout screen. No String TIMER_DETAILS
Icon options

PantsLabyrinth

These are the deep links for the PantsLabyrinth fictional brand app in Pilot.

braze-pilot://navigation/pantslabyrinth/itemdetails?name=Jeans&price=85&image=https://picsum.photos/400&description=This%20item%20is%20awesome%21&quantity=2&size=Large&colors=%230000FF,%23FF0000&color_strings=White,Blue&selected_color=1

Accepted parameters

Parameter Description Required Default (if not specified) Type Example
name The name of the item. Yes String Jeans
price The price of the item. Yes String 85
image The URL of the image of the item. Yes String https://picsum.photos/400
description The description of the item. Yes String This%20item%20is%20awesome%21
quantity The quantity of the item. No 1 Number 2
size A string representing the size of the item. No M String Large
colors A list of hex colors separated by commas. These are the colors available for the item. No %23000000 String %230000FF,%23FF0000
color_strings A list of the color strings separated by commas. Represents the colors in text. No Black String Blue, Red
selected_color The selected index of the color to be selected in the color selector when the user arrives on the screen. If no value is used, it has the first color selected. No 0 Number 1

MovieCanon

These are the deep links for the Steppington fictional brand app in Pilot.

braze-pilot://navigation/moviecannon/moviedetails?id=1&title=Jaws&thumbnail=https://picsum.photos/400&video=0&description=This%20video%20is%20awesome%21

Accepted parameters

Github   Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!