Configuring Events
Chunk #1
2.3. One Time event
**One-time events** are single-instance events that are configured to happen at a specific time, date, and duration. One-time events are designed for scenarios where a specific in-game activity is meant to run for a limited, predetermined period.
Perform the following steps to configure a one-time event:
1. Navigate to Configurations, and click **[+Add Configurations]** in the upper right corner.
2. Click One time event.
3. Fill in the fields to create a configuration:
Expand the [**Event fields**](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/3583279198/Configuring+Events#Field-Name)  section above for more details.
 
Once you configure Event fields, you are ready to configure rest of your event properties.
Notice that Parameters of your event will appear after selection of event type parameter in event fields.
1. Click the [**+Serve the configuration to players toggle**] to inactivate the configuration. Players will not be served this particular configuration and the parameters section will no longer be displayed.
Default: the toggle is on and the configuration is active and will be served to players.
If a player qualifies for an event where a configuration isn’t served, and there is another event of the same type with higher priority after the player was already allocated to the previous event, the player will **not** receive the second event’s configuration.
The main use case for this toggle is A/B experiment, where you can control which variant will receive the configuration, and which will not.
1. **Parameters:** The parameters section comprises a list of parameters with Name, Key, Value, Type, and Default Value fields that are defined in event.
You can modify the pre-defined **Value** fields however the rest of the fields can only be modified at the time of configuring the event type. Refer to the [Parameters](https://tripledotstudios.atlassian.net/wiki/x/HoDV9Q?atlOrigin=eyJpIjoiZTY4OTg1MmZlMjFjNDMyNWE3NThjOTViZWQwOGFhOWUiLCJwIjoiYyJ9) User Guide for more details.
2. Next, click **[+Add Activity]** to configure your activity type. A new section will open where you will be able to select:
3. Once you’re done with your configuration, click **[Save]** on the bottom left side of the screen.
4. The event appears in the **Events Configurations** list. From the events list, you can edit, duplicate, and delete the event if needed. [ ]
**Players are assigned to a segment during the preload, and even if they change segments, they will stay in the previously assigned event until the next preload of an event!**
**Do you need support?**
If you need support, you can obtain the Entity Variant ID from any Event. This will help the Hawk team identify your issue better and provide more accurate support!
## 2.3. Recurring Event
The **recurring event** feature allows you to configure events that automatically repeat over a specified time frame without the need for repeated manual configurations.
This feature is useful when you want to create events that span multiple days or occur periodically without setting each event individually.
The Recurring Events Configuration is explained in detail [**here**](https://tripledotstudios.atlassian.net/wiki/x/FgDU9Q).
**What are Activities?**
Activities are the building blocks of an event. They define what players actually do during the event. Whether it's completing objectives, competing in races, or climbing leaderboards, each activity type brings a unique challenge or reward. Activities help shape the player experience and keep events engaging and dynamic.
To learn more about the different activity types and how to configure them, head over to the [**Configuring Activities**](https://tripledotstudios.atlassian.net/wiki/x/CgCy2Q) section.
## 2.4. Onboarding Event
Onboarding Events are designed to guarantee a complete player experience. Unlike recurring or one-off events, Onboarding Events are triggered at the right moment for the player (e.g., after reaching a specific level).
Since recurring events may not align with when a player reaches eligibility, onboarding events ensure they still get the full experience. For example, if a recurring event spans 2 days, a player reaching level 10 during cooldown would miss it. Onboarding Events solve this by triggering the event as soon as the player becomes eligible.
The Onboarding Events Configuration is explained in detail [**here**](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/4367319345/Onboarding+Events?atlOrigin=eyJpIjoiZWU1OTZhNWI0MWU0NDYzMzk4MmU5ZDIxNGFkZjQ4NGIiLCJwIjoiYyJ9).
Recurring Events
Chunk #0
# Introduction
In this guide, you’ll learn…
- Creating and Managing Event Configurations: Setting up recurring events, defining parameters, and configuring activities.
- Activity and Parameter Management: Choosing between predefined sets or custom configurations for structured event execution.
- Recurrence Setup: Configuring events to repeat based on cooldown periods or weekly schedules, ensuring no overlaps.
- Validation & Troubleshooting: Avoiding scheduling conflicts and resolving errors when setting event occurrences.
- Event Scheduling with Segment Changes: Handling segment-based scheduling logic using Offset and Weekly recurrence models.
* * *
# Recurring Event Configuration
Recurring events automate event scheduling by allowing predefined activities and parameters to repeat over time. These events can be configured with fixed cooldown periods or weekly recurrence.
Perform the following steps to configure a **Recurring Event** :
1. Navigate to Configurations, and click **[+Add Configurations]** in the upper right corner.
2. Click **Recurring Event**.
3. Fill in the fields to create a configuration:
See the[Events Fields](https://tripledotstudios.atlassian.net/wiki/spaces/KB/pages/3583279198/Configuring+Events#Event-Fields-table) table for more details.
When you select an Event type, the parameters from event type appear. For recurring events, the recurrence configuration becomes available **only after adding activities and configuring their duration.**
1. Click the [**+Serve the configuration to players toggle**] to inactivate the configuration. Players will not be served this particular configuration and the parameters section will no longer be displayed.
Default: the toggle is on and the configuration is active and will be served to players.
If a player qualifies for an event where a configuration isn't served, and there is another event of the same type with a higher priority, the player won't receive the second event's configuration, even if the first doesn't serve a configuration.
Recurring Events
Chunk #2
Recurrence Configuration
You can configure event recurrences in two ways:
- **Cooldown-based:** Set a cooldown period between consecutive occurrences.
- **Weekly-based:** Choose specific days of the week for the event to recur.
The following table explains the available fields and steps for each configuration method.
| **Field** | **Description** | **Default/Options** | **Steps to Configure** |
| --- | --- | --- | --- |
| **Limit number of occurrences** | Allows you to limit how many times the event occurs. | Default: OFF (unlimited occurrences) | Toggle ON to enable. Enter the number of occurrences (e.g., 5, 10) in the "Number of occurrences" field that appears. |
| **Number of Occurrences** | Allows you to specify the number of occurrences. | Only available when the Limit Number of occurrences toggle is on. | Specify the number of occurrence for the event. |
| **Duration of event occurrence** | Displays the total duration of each event cycle (non-editable). | Based on activities and durations set earlier. | No input needed. This field is auto-calculated based on the event's duration (e.g., 10 days). |
| **Occurrence Frequency** | Allows you to choose how often the event recurs: Cooldown-based or Weekly-based. | Options: Cooldown-based (default), Weekly-based | Select one of the two options: Cooldown-based or Weekly-based. |
| **Occurrence Details** | Displays the status of the event occurrences. The **Next Occurrences** are also listed, providing a schedule for when future occurrences of the event will happen. The **Refresh** button allows you to manually update the list of occurrences. This is important because changes to the configuration are **not automatically calculated**. | Based on Occurrence configuration | No input needed. This field is auto-calculated |
#### **Cooldown-based Recurrence**
**Cooldown-based** recurrences allow you to define a specific cooldown period between consecutive event occurrences.
This means the event will restart after a defined waiting period, such as 2 days or 12 hours, regardless of the day of the week.
| **Field** | **Description** | **Default/Options** | **Steps to Configure** |
| --- | --- | --- | --- |
| **Cooldown between occurrences** | Defines the waiting period between consecutive event occurrences (Cooldown-based). | Days, Hours, Minutes | Input the cooldown period in days, hours, and minutes (e.g., 2 days, 0 hours, 0 minutes). |
#### **Weekly-based Recurrence**
**Weekly-based** recurrences enable you to set specific days of the week on which the event will repeat, such as every Monday and Thursday, or at an interval of every two weeks.
| **Field** | **Description** | **Default/Options** | **Steps to Configure** |
| --- | --- | --- | --- |
| **Start of occurrence** | Defines the day(s) of the week the event will start (Weekly-based). | Days of the week: Monday, Tuesday, Wednesday, etc. | Select one or more days for the event to start (e.g., Monday and Thursday). |
| **Repeat every [X] weeks** | Defines how frequently the event repeats in weeks (Weekly-based). | Default: 1 | Input the number of weeks between recurrences (e.g., to repeat every 2 weeks, enter 2). |
For weekly-based recurring events, the start time of each occurrence will align with the event’s configured start time, **not midnight**. For example, if an event's start time is set to 10:00 AM, all weekly occurrences will also start at 10:00 AM.
**Note:** Ensure that the event’s start time is configured correctly to match the desired occurrence start time, as it will automatically propagate to all occurrences.
#### Validation: Avoid Overlapping Event Occurrences
When configuring an event that recurs on **multiple days** in a week (e.g., Monday and Thursday), it’s crucial to ensure that the **duration** of the event does not cause the occurrences to overlap. Overlapping occurs when a new event starts while a previous one is still ongoing.
**Scenario:**
If your event's **duration** is long (e.g., 6 days), and you select **two or more start days** (e.g., Monday and Thursday), and the event repeats **every week** , the system may detect an overlap between occurrences and prevent saving the event configuration.
**Example Configuration:**
1. **Event Duration** : 6 days
2. **Occurrence Days** : Monday and Thursday
3. **Repeat Every** : 1 week
With this configuration, the system identifies a conflict because:
- **First event** starts on **Monday** and lasts for 6 days (Monday to Saturday).
- The second event is scheduled to start on **Thursday** of the same week, which falls **within the duration of the first event**.
- This causes an **overlap** , as the Thursday occurrence would begin **before the Monday occurrence has ended**.
**System Validation:**
- As this overlap is detected, the system will display an error message like **"Occurrences are overlapping."**
- The system will not allow you to save the event configuration until the overlap is resolved.
**How to Resolve the Overlap:**
There are two ways to resolve this issue:
1. **Reduce the Event Duration** :
2. **Increase the Time Between Recurrences** :
**Key Points to Remember** :
- **Ensure that event durations don’t overlap with the next occurrence**. Either reduce the event duration or increase the time between recurrences to avoid overlap.
- If you select **multiple occurrence days** in the same week (e.g., Monday and Thursday), ensure that the total event duration allows enough time between these days.
- If your occurrences are longer than a week, ensure that you don’t repeat the event every week.
- If you receive the **“Occurrences are overlapping”** error, review your event duration and recurrence settings to make necessary adjustments.
Once you’re done with your configuration, click **[Save]** on the bottom left side of the screen.
### **Event Recurrence Logic**
Let us understand the event recurrence logic with the help of an example.
**Example: Configuring a Recurring Event Every Wednesday and Friday (Every 2 Weeks)**
You want to create a recurring event that happens every **Wednesday** and **Friday** , repeating **every 2 weeks**. The event starts on **Thursday, 19th September**.
#### Configuration Details
- **Event Start Date:** Thursday, 19th September.
- **Event Days:** Wednesday and Friday.
- **Recurrence Interval:** Every 2 weeks.
**Expected Event Occurrences:** (When number of occurrences are not limited)
1. **First Event:** **Friday, 20th September**.
2. **Second Event:** **Wednesday, 2nd October**.
3. **Third Event:** **Friday, 4th October**.
4. **Fourth Event:** **Wednesday, 16th October**.
5. **Fifth Event:** **Friday, 18th October**.
6. **Sixth Event:** **Wednesday, 30th October**.
7. **Seventh Event:** **Friday, 1st November**.
**How It Works:**
- The event starts on the first available day after the start date (Friday, 20th September).
- A **1-week gap** is added after the first event to maintain the recurrence interval of 2 weeks for both event days (Wednesday and Friday).
- The **week break** refers to skipping an entire **Monday-to-Sunday** week, regardless of how many days pass between the last event and the next. This ensures that events are spaced by full calendar weeks rather than simply counting a set number of days.
- The event will occur **in the same week** (on Wednesday and Friday) every 2 weeks from that point onward.