Onboarding Events

KB
Version 6
Updated 4 months ago
1 chunks
View in Confluence

Content

Introduction

In this guide, you’ll learn…

  • Creating and Managing Onboarding Event Configurations

  • Activity and Parameter definition for onboarding events

  • Configuring Formula parameters for onboarding events


Onboarding Event Configuration

Onboarding events ensure a complete event experience by triggering personalised events when a player meets specific conditions, such as reaching a level milestone. Onboarding events ensure players receive the full event experience. They become available once a player meets specific conditions (e.g., reaching a certain level) and can be served continuously from that point. The client decides when the event actually starts for the player.

Unlike scheduled events, onboarding events begin individually per player and are designed to guarantee that new players don’t miss key early-game content due to global timing limitations.

How to Create an Onboarding Event

  1. Navigate to Events > Configurations

  2. Go to the Events section in the left navigation panel.

  3. Click Configurations.

  4. Click [➕ Add Configuration] select Onboarding Event from the dropdown.

2. Onboarding Events Fields

Fill in the event details:

| Field | Description |

| --- | --- |

| Name | A unique and descriptive name |

| Priority | Shared across all events. Determines processing order |

| Status | Choose between Active or Inactive or Temporarily Archived. Cannot remove an onboarding event once Active. |

| Availability | Set to Test or Live |

| Event Type | Choose from predefined types (e.g., Default, Race) |

| Start At | Required, but onboarding events activate per player trigger |

| Segment Type | Define who should see the event (e.g., "All Players" or custom cohorts) |

image-20250808-115335.png

3. Duration

  • Duration is automatically calculated as the sum of all activity durations.

  • Displayed under the toggle "Serve the configuration to players".

4. Parameters

Onboarding events inherit parameters from the selected Event Type. Refer to the Parameters User Guide for more details.

| Column | Description |

| --- | --- |

| Name | Parameter label |

| Key | System-readable identifier |

| Value | Can be float, list, integer, or formula |

| Type | Format type (e.g., List, Integer, Formula, Asset Bundle etc.) |

| Default Value | Used when no specific value is found |

image-20250808-120620.png

5. Activities

Activities define what players experience during the onboarding event.

For each Activity:

| Field | Description |

| --- | --- |

| Duration | Specify time per activity |

| Limit Participation Window | This setting can be ON or OFF for onboarding activities. Since onboarding activities are not segmented, Liveops will always serve the configured value as is. |

| Activity Type | Choose from supported types (e.g., Objectives, Race, Client Leaderboards, League, Flexible) |

| Activity Configuration | Select a pre-defined configuration |

  • Click ➕ Add Activity to add more activities.

Onboarding does not allow Collection Set as an Activity Type.

image-20250808-185224.png

Filters and Tracking

Filters (Top Bar):

  • Recurrence Type
    Options: Recurring, One-off, Onboarding

Activity Log:

  • All onboarding event creation and updates are logged under Activity Log

In-Use References

Onboarding Events appear in:

  • Event Type in-use lists

  • Activities in-use lists

  • Asset Bundles

  • Files

  • Localisation Keys

  • Flexible Activities

Restrictions

  • Cannot delete an onboarding event if it's marked as Active

  • Activities in onboarding events are not segmented.

  • Only applicable to eligible players when they meet defined triggers (e.g., reach a certain level)


Chunks 1

1
# Introduction In this guide, you’ll learn… - Creating and Managing Onboarding Event Configurat...
Vectorized

# Introduction

In this guide, you’ll learn…

- Creating and Managing Onboarding Event Configurations

- Activity and Parameter definition for onboarding events

- Configuring Formula parameters for onboarding events

* * *

## Onboarding Event Configuration

Onboarding events ensure a complete event experience by triggering personalised events when a player meets specific conditions, such as reaching a level milestone. Onboarding events ensure players receive the full event experience. They become available once a player meets specific conditions (e.g., reaching a certain level) and can be served continuously from that point. The client decides when the event actually starts for the player.

Unlike scheduled events, onboarding events begin individually per player and are designed to guarantee that new players don’t miss key early-game content due to global timing limitations.

### How to Create an Onboarding Event

1. Navigate to **Events** \> **Configurations**

2. Go to the **Events** section in the left navigation panel.

3. Click **Configurations**.

4. Click **[➕ Add Configuration]** select **Onboarding Event** from the dropdown.

### 2. Onboarding Events Fields

Fill in the event details:

| **Field** | **Description** |

| --- | --- |

| **Name** | A unique and descriptive name |

| **Priority** | Shared across all events. Determines processing order |

| **Status** | Choose between Active or Inactive or Temporarily Archived. Cannot remove an onboarding event once Active. |

| **Availability** | Set to Test or Live |

| **Event Type** | Choose from predefined types (e.g., Default, Race) |

| **Start At** | Required, but onboarding events activate per player trigger |

| **Segment Type** | Define who should see the event (e.g., "All Players" or custom cohorts) |

![image-20250808-115335.png](https://tripledotstudios.atlassian.net/wiki/download/thumbnails/4367319345/image-20250808-115335.png?version=1&modificationDate=1754654019143&cacheVersion=1&api=v2&width=1241&height=379)
### 3. Duration

- Duration is automatically calculated as the sum of all activity durations.

- Displayed under the toggle "Serve the configuration to players".

### 4. Parameters

Onboarding events inherit parameters from the selected Event Type. Refer to the [Parameters](https://tripledotstudios.atlassian.net/wiki/x/HoDV9Q?atlOrigin=eyJpIjoiZTY4OTg1MmZlMjFjNDMyNWE3NThjOTViZWQwOGFhOWUiLCJwIjoiYyJ9) User Guide for more details.

| Column | Description |

| --- | --- |

| **Name** | Parameter label |

| **Key** | System-readable identifier |

| **Value** | Can be float, list, integer, or formula |

| **Type** | Format type (e.g., List, Integer, Formula, Asset Bundle etc.) |

| **Default Value** | Used when no specific value is found |

![image-20250808-120620.png](https://tripledotstudios.atlassian.net/wiki/download/thumbnails/4367319345/image-20250808-120620.png?version=1&modificationDate=1754654782322&cacheVersion=1&api=v2&width=1217&height=212)

### 5. Activities

Activities define what players experience during the onboarding event.

#### For each Activity:

| **Field** | **Description** |

| --- | --- |

| **Duration** | Specify time per activity |

| **Limit Participation Window** | This setting can be ON or OFF for onboarding activities. Since onboarding activities are not segmented, Liveops will always serve the configured value as is. |

| **Activity Type** | Choose from supported types (e.g., Objectives, Race, Client Leaderboards, League, Flexible) |

| **Activity Configuration** | Select a pre-defined configuration |

- Click **➕ Add Activity** to add more activities.

Onboarding **does not allow Collection Set** as an Activity Type.

![image-20250808-185224.png](https://tripledotstudios.atlassian.net/wiki/download/thumbnails/4367319345/image-20250808-185224.png?version=1&modificationDate=1754679147581&cacheVersion=1&api=v2&width=1241&height=383)
## Filters and Tracking

### Filters (Top Bar):

- **Recurrence Type**
Options: Recurring, One-off, Onboarding

### Activity Log:

- All onboarding event creation and updates are logged under Activity Log

## In-Use References

Onboarding Events appear in:

- Event Type in-use lists

- Activities in-use lists

- Asset Bundles

- Files

- Localisation Keys

- Flexible Activities

## Restrictions

- Cannot delete an onboarding event if it's marked as Active

- Activities in onboarding events are not segmented.

- Only applicable to eligible players when they meet defined triggers (e.g., reach a certain level)

* * *

Vector dimensions: 1536

Details

Confluence ID
4367319345
Space Key
Version
6
Created
November 06, 2025 at 11:34 AM
Last Updated
November 06, 2025 at 11:34 AM
Last Modified (Confluence)
August 20, 2025 at 09:19 AM
Content Size
4.47 KB