Add an Offer Group

Configuring an offer group requires three steps:

Create an Offer Group: Set a name, slug, description, and select a presentation schema.
Add Offers to Slots: Define how many slots you need and assign offers to each slot with priority ranking.
Configure Presentation: Set content for the offer group container (title, checkout URL, etc.).

To begin, navigate to the Offer Groups section in the left-hand navigation menu.

Your offer groups page shows a list of configured offer groups and allows you to edit existing offer groups or add new ones. The list displays the name and description, presentation schema, last updated date, linked brands, and option to edit an offer group.

To create an offer group, click 'Add an Offer Group'.

You will be prompted to give your offer group a name, slug, and optional description. You must also select a presentation schema (product selection or sticky banner). By default, the slug will be a hyphenated version of the name you give the offer group, but you can override this if you wish.

If you have Brands enabled, you must link this offer group to a particular brand or brands by clicking the 'Link Brands' button. This means the offer group will only be available in environments linked to that specific brand or brands.

Once done, click 'Create'.

Configure Your Offer Group

Once you've created your offer group, you will be taken to the manage page. The page has three tabs across the top that guide you through offer group configuration:

Manage

The Manage tab allows you to update the basic details of your offer group including name, slug, description, and linked brands.

Please note: You cannot change the presentation schema once it has been set.

Offers

The Offers tab allows you to configure slots and assign offers to each slot.

Add Slots

Set the number of slots in your offer group by clicking 'Add Slot'. For product selection offer groups, we recommend 1-3 slots. For sticky banner offer groups, we recommend 1 slot.

You can drag and drop slots to rearrange them. Clicking the cog icon allows you to rename an offer slot.

Add Offers to Slots

Add offers to a slot by clicking the 'Add Offer' button. A sheet will open with all your available offers. Select them with the checkboxes then click 'Add Offer'.

You can assign multiple offers to each slot and drag and drop them into priority order. When the offer group is displayed, the system will evaluate each offer's filter options (user type, time range, plans, location) and display the highest-priority eligible offer for that slot.

If you haven't created any offers yet, learn how to add an offer here.

Once you've configured your slots and offers, click 'Update'.

Presentation

The Presentation tab allows you to set content for the offer group container. While individual offer presentation defines the content for each specific offer, the offer group presentation sets content for the shell surrounding the set of offers.

Product Selection Offer Groups

You can set:

Title: The main heading for the offer group
Checkout URL: The URL for redirecting to the checkout page

You can set:

Title: The main heading for the sticky banner
Tag Line: Supporting text for the banner
Checkout URL: The URL for redirecting to the checkout page
Dismissible: Whether users can dismiss the sticky banner

Both presentation options can be edited via a text editor or using JSON.

Once done, click 'Update'.

Display Your Offer Group

Once your offer group is fully configured, it needs to be referenced in a surface or component workflow in order to be displayed.

Here's an example for an offer group called 'article-offers':

const offering = await utils.offers.generate({
  offerGroup: "article-offers",
  identifier: identity,
});

If you're using our Cloudflare proxy worker, the proxy will automatically display the offer by injecting the appropriate HTML. Otherwise we will return the required information in the response for you to interpret in your front end.

Add an Offer Group