Skip to content

Shop

Complete guide for setting up Shop items using XtremePush Loyalty and Directus

1 - Creating Item on XtremePush

Access XP

  1. Go to https://dashboard.eu.xtremepush.com/
  2. Log in and complete authentication
  3. Select the correct project:
    • ITVWin_Prod — production environment
    • ITVWin_STG — staging environment
  4. In the right-hand navigation, go to Xperience Hub then Loyalty Hub

Create Shop Item

  1. In the left sidebar: click redeem > options.
  2. Click the blue create button top right.
  3. Click the digital option
  4. Enter the following details
FieldValue
TitleTitle of item in XP
Product PriceNumber of tokens the item will cost
Webhook Urlstaging:
free spins: https://dev.itvwin.com/api/xp/fs/[bonusTemplateId]
free ticket: https://dev.itvwin.com/api/xp/ft/[bonusTemplateId]
prod:
free spins: https://itvwin.com/api/xp/fs/[bonusTemplateId]
free ticket: https://itvwin.com/api/xp/ft/[bonusTemplateId]
Authorization HeaderAlways required. Ask the product team.

No need to touch any other field entries, leave all as they are.

  1. Click Save Button

You should now see the Shop Item you have created in the Redeem > Options page in the XtremePush Loyalty Section.

  1. Shop Item Reward ID

Notice the Name (ID) column, this ID will be important for later and linking the created shop item in Xtreme Push to Directus.

For an example, look at:

2 - Creating Shop Collection on Directus

Access Directus

  1. Go to Directus
  2. Navigate to Bingo or Spins
  3. Choose the category where you want to add Shop collection

Create Collection

  1. Click the Create New button under Collections
  2. Enter the following details
FieldValue
StatusPublished (choose Draft if you don't want it visible yet)
Internal NameName of Shop Collection (must be unique)
TypeShop Products
TranslationsEnabled
TitleShop collection title
SlugURL slug for the shop collection
  1. Click Create new Star Product
  2. Click Save button in the top right

3 - Creating Shop Item On Directus

Below are the possible fields for a shop item in Directus. Required fields are marked with *

FieldDescription
* StatusSet to Published to make the item live. Use Draft while building.
* Internal NameUsed for identifying the item inside Directus. Not shown to users — convention is to match the Title in caps (e.g. 200 FREE TICKETS).
* Reward IdMust match the Reward ID in XtremePush exactly. This is what links the Directus record to the actual reward. See the XtremePush section for where to find this ID.
* TitleThe headline shown on the shop tile (e.g. 200 FREE TICKETS).
* DescriptionShort supporting line displayed under the title (e.g. On The ITV Room!).
SubtextOptional additional copy. Leave blank if not needed.
* Desktop Image4:1 aspect ratio. Used on desktop viewports.
* Mobile Image1:1 aspect ratio. Used on mobile viewports.
BadgeOptional label shown as a badge on the tile (e.g. Free, New, Limited).
* CTA CopyButton label (e.g. Play Game).
* CTA URLDestination when the CTA is clicked.
Show for Logged OutWhen ticked, the item is visible to unauthenticated users. Leave unticked for logged-in-only rewards.
Colour SchemeControls the accent colour used for the shop item tile. Options: Bingo, Spins.

Once entered all desired details, in the top right click the save button.