> ## Documentation Index
> Fetch the complete documentation index at: https://help.lobyco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Deeplinks

> The app screens you can send a customer to from a push, banner, feed or prompt, and how to link to one offer, game or challenge.

A deeplink opens a screen in your app when a customer taps your message. This page lists the deeplinks you can pick in a push, banner, feed or prompt. It also shows how to send a customer to one offer, game or challenge.

## At a glance

Lobyco sets up this list for your app. You can't change it in Lobyco Nexus.

Some deeplinks open one specific thing, so they ask for its ID. The last column names the box that appears when you pick one.

| Deeplink | Opens | Fill in |
| - | - | - |
| **HOME** | The app's home screen | Nothing |
| **OFFERS\_OVERVIEW** | The list of offers | Nothing |
| **COUPONS\_BY\_TYPE** | The list of offers, showing one offer type | **campaignType** |
| **COUPONS\_BY\_CHAIN\_ID** | The list of offers, showing one chain | **chainId** |
| **COUPON\_DETAILS** | One offer | **campaignId**, the [offer's ID](#link-to-one-offer-game-or-challenge) |
| **COUPON\_DETAILS\_BY\_COUPON\_ID** | One coupon for an offer | **campaignId**, the [offer's ID](#link-to-one-offer-game-or-challenge), and **couponId** |
| **BONUS** | The bonus overview | Nothing |
| **CURRENT\_GAME** | The game that's running now | Nothing |
| **GAME\_BY\_ID** | One game | **gameId**, the [game's ID](#link-to-one-offer-game-or-challenge) |
| **LEAFLETS** | The list of leaflets | Nothing |
| **LEAFLET\_FOR\_CHAIN\_ID** | One chain's leaflet | **chainId** |
| **RECEIPTS** | The list of receipts | Nothing |
| **RECEIPT\_DETAILS** | One receipt | **receiptId** |
| **LOYALTY\_SUBSCRIPTION** | The loyalty subscription screen | Nothing |
| **MEMBER\_SAVINGS** | The savings screen | Nothing |
| **PAYMENT\_SETTINGS** | The payment settings | Nothing |
| **SHOPPING\_LIST** | The shopping list overview | Nothing |
| **SHOPPING\_LIST\_BY\_ID** | One shopping list | **shoppingListId** |
| **CHALLENGES** | The list of challenges | Nothing |
| **CHALLENGE\_DETAILS** | One challenge | **stampCardId**, the [challenge's ID](#link-to-one-offer-game-or-challenge) |
| **VOUCHERS** | The list of vouchers | Nothing |
| **VOUCHER\_DETAILS** | One voucher | **voucherId** |

**campaignId** takes the offer's ID, not the ID of the campaign the offer sits in.

## Where you pick a deeplink

A push, banner, feed and prompt all offer the same list. Only the place you find it changes. An email has no deeplink.

| Communication | Where to find it |
| - | - |
| [Push](/business-documentation/communication/push) | **In app action**, under the message |
| [Banner](/business-documentation/communication/banner) | **Banner call-to-action**, then **App deep-link** |
| [Feed](/business-documentation/communication/feeds) | Tick **Add button**, then pick **In-app navigation** |
| [Prompt](/business-documentation/communication/prompt) | **In-app navigation**, under **Approve button text** and under **Decline button text**, once you've filled them in. Only a **Regular** prompt has it. |

Pick a deeplink from **Choose from list**. If it needs an ID, a box named after that ID appears under the list.

![The Create Push form scrolled to In app action, with the Choose from list field open. The hint above it says to copy the activity ID from the activity's configuration page when linking to a specific activity. The open list starts with HOME, then OFFERS\_OVERVIEW, COUPONS\_BY\_TYPE, COUPON\_DETAILS, BONUS and CURRENT\_GAME, and scrolls for more.](https://mintcdn.com/lobyco-4c9fb3ad/rG971_5ZfS49bcjM/images/deeplinks-01-deeplink-list-open.png?fit=max\&auto=format\&n=rG971_5ZfS49bcjM\&q=85\&s=c637372f3451b9a26735ffa170079fc2)

*The deeplink list, open*

## Link to one offer, game or challenge

Three deeplinks open one activity you built. Each one needs that activity's ID.

| To open | Pick | Paste the ID into |
| - | - | - |
| An offer | **COUPON\_DETAILS** | **campaignId** |
| A game | **GAME\_BY\_ID** | **gameId** |
| A challenge | **CHALLENGE\_DETAILS** | **stampCardId** |

1. Open the offer, game or challenge you want to link to.
2. Find **id** at the top of its first panel. It only shows once the activity is saved.
3. Select the copy icon next to it. The portal confirms it's copied.
4. Open your push, banner, feed or prompt. Under **Choose from list**, pick the deeplink the table above names.
5. Paste the ID into the box under the list.

Don't copy the ID from the page address. The address doesn't hold it anymore.

![A saved draft challenge, Coffee week stamp card, open on its Activity details tab. Above the first field, the grey line id: 02da4e15-dab2-4eb9-96d4-9ab9426ff804 ends with a copy icon. Below it are Activity name, Start date 2026/11/02 00:00, End date 2026/11/29 23:00, Display priority 5, Chain(s) SuperTasty and Assign a tag. The footer has Cancel, Delete, Save and a greyed-out Publish.](https://mintcdn.com/lobyco-4c9fb3ad/rG971_5ZfS49bcjM/images/deeplinks-02-activity-id-ready-to-copy.png?fit=max\&auto=format\&n=rG971_5ZfS49bcjM\&q=85\&s=62ce4fce58230eab6c08346d8c79501a)

*A saved challenge's ID, with the copy icon next to it*

## When a deeplink shows a warning

A warning means the deeplink is missing an ID, so it can't open the screen you meant. You see it in two places:

* In the form, as an orange line under the ID box.
* In the campaign's **List** view, as a warning icon next to the activity's name. Point at it to read the warning.

Fill in every ID box to clear it.

Creating a [campaign from a template](/business-documentation/campaigns/create-a-campaign) can leave a deeplink empty too. Lobyco copies every activity in the template. A deeplink to an offer, game or challenge in the same template opens the new copy. A deeplink to a game in another campaign comes across empty and shows the warning. A deeplink to an offer or challenge in another campaign comes across unchanged, so it still opens that offer or challenge. Before you publish the new campaign, fill in every empty ID. Then check that each offer or challenge deeplink opens the one you want.

## Related

* [Push notifications](/business-documentation/communication/push), [Banners](/business-documentation/communication/banner), [Feeds](/business-documentation/communication/feeds) and [Prompts](/business-documentation/communication/prompt) — the forms where you pick a deeplink.
* [Offers](/business-documentation/activities/offers), [Games](/business-documentation/activities/games) and [Challenges](/business-documentation/activities/challenges) — the activities a deeplink can open by ID.
* [Create a campaign](/business-documentation/campaigns/create-a-campaign) — starting a campaign from a template, which copies its deeplinks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.