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

# Portal configuration of events

> Create, edit, copy, and delete XBOX Live event definitions in Partner Center so your title can send telemetry that updates stats and achievements.

> [!NOTE]
>
> This topic only applies if you're using event-based User Stats, not title-managed User Stats.

> [!NOTE]
>
> This topic describes the features that are available only with proper permissions. For details, talk to your account manager or another contact at Microsoft.

This topic describes the procedures for adding and changing events in the Partner Center service configuration for a title. If a title is using event-based Stats, events are the key data sent by the title to XBOX services to update stats and leaderboards and to unlock achievements.

For an introduction to XBOX services configuration, see [XBOX services overview](https://devdocs.xbox.com/services/xbox-services/fundamentals/live-xbl-overview.md).

This topic covers the following:

* [What is an event?](#ID4EKB)
* [Configure an event](#ID4EYM)
* [Create an event](#ID4EUB)
* [Change an event](#ID4EYE)
* [Copy an event](#ID4EBG)
* [Delete an event](#ID4EBL)

## What is an event?

An *event* is anything that happens during play and can be *captured*. A player acquiring a weapon is an event, and so is defeating an enemy by using that weapon.

An event consists of the event name, an event description, and a number of fields that contain event-related data. When a title writes an event, it's stored on the local device until it can be sent to XBOX services. It receives the event and uses it to build and update stats, leaderboards, achievements, and other features of event-based Stats according to the rules that you define in the service configuration.

For more details about events, see [Events overview](https://devdocs.xbox.com/services/xbox-services/player-data/stats-leaderboards/event-based/events/live-game-events.md).

[Return to the top of this topic.](#top)

## Configure an event

1. Sign in to your account on [Partner Center](https://developer.microsoft.com/dashboard/windows/overview).

2. Select your title, and then select **XBOX services** > **Gameplay settings** in the left navigation pane.

3. Select the link **Player stats** > **Stat rules**.

4. On the **Events and stat rules** page, shown as follows, configure the events and stat rules according to the events.

   ![Screenshot of the Events and stat rules page in Partner Center.](https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/services/events-and-stat-rules-1.png?fit=max\&auto=format\&n=gzrdvT5kpqAXKEQt\&q=85\&s=53345d0eb82e9e60332ffa25b1a14054)

[Return to the top of this topic.](#top)

## Create an event

1. Go to the **Events and stat rules** page as described in the previous section.

2. Select **New event**. The **Add new event** dialog appears, shown as follows.

   ![Screenshot of the Add new event dialog in Partner Center.](https://mintcdn.com/microsoft-4404708b/ktEik-YaZoen6Rhy/images/gdk/services/pctr-add-new-event-dbox.png?fit=max\&auto=format\&n=ktEik-YaZoen6Rhy\&q=85\&s=25f2ab8246896159d606bf501295cdff)

3. Specify the values for the following fields.

   * **Base event**: From the dropdown list, shown as follows, select the base event that you want to build your new event on. The selected base event controls the default fields that your new event is prepopulated with. You can add any other fields, but you can't remove the default fields.

   ![Screenshot of the Base event list in Partner Center.](https://mintcdn.com/microsoft-4404708b/ktEik-YaZoen6Rhy/images/gdk/services/pctr-base-event-list.png?fit=max\&auto=format\&n=ktEik-YaZoen6Rhy\&q=85\&s=bb49035ec3df875ea0727bef1393f243)

   * **Event name**: Enter a name that characterizes the event and that you can easily remember and recognize. The event name doesn't have to match the name of the base event that you selected for the new event. Event names aren't displayed to the player and are internal to the code and game studio. Event names must be unique within a provider namespace: game studios can't have duplicate event names.

   * **Description**: Enter a brief description of the event. This text is optional and hidden from the player. The following screenshot shows the **Add new event** dialog with information added to its fields.

   ![Screenshot of the Add new event dialog with information added to its fields in Partner Center.](https://mintcdn.com/microsoft-4404708b/ktEik-YaZoen6Rhy/images/gdk/services/pctr-add-new-event-dbox-filled-in.png?fit=max\&auto=format\&n=ktEik-YaZoen6Rhy\&q=85\&s=b9f6f2325b76a22de9c7ca8d6da63f4b)

   * **Event fields**:
     * The fields in this list, shown as follows, represent the data that will be captured in connection with the new event.
     * To add an event field, select **Add event field** and then specify the **Field** name and **DataType**.
     * Field types have character limits. They're as follows.

       * Achievement name: 44
       * Achievement rule name: 44
       * Locked description: 100
       * Unlocked description: 100
       * In-app reward name: 57
       * In-app reward description: 90
       * Art reward name: 57
       * Art reward description: 90
       * Rich presence: 44
       * Hero stat name: 44

   ![Screenshot of adding an event field in Partner Center](https://mintcdn.com/microsoft-4404708b/ktEik-YaZoen6Rhy/images/gdk/services/pctr-add-event-field.png?fit=max\&auto=format\&n=ktEik-YaZoen6Rhy\&q=85\&s=871e9f749f6af12e6ac3ab9408bf9195)

4. Select **Save** to create the event and close the dialog, shown as follows.

   ![Screenshot of the Add new event dialog with a new Basic base event in Partner Center.](https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/services/add-event-dialog.png?fit=max\&auto=format\&n=gzrdvT5kpqAXKEQt\&q=85\&s=99d9aff3f2e437f4f91988f317ab3803)

Your new event is now listed on the **Events and stat rules** page, shown as follows.

![Screenshot of the Events and stat rules page with the RecruitUnit event added in Partner Center.](https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/services/events-and-stat-rules-2.png?fit=max\&auto=format\&n=gzrdvT5kpqAXKEQt\&q=85\&s=1bac3e1ee375b5735643f078f684afc4)

Now that you've defined an event, you can select the right side of the **Events** row to define a stat rule that uses the event. For more information, see [Portal configuration of event-based Stats](https://devdocs.xbox.com/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-stats-eb-portal.md).

[Return to the top of this topic.](#top)

## Change an event

> [!NOTE]
>
> * After a title passes Final Certification, existing events in that title can't be changed except to add new event fields.
>
> * It's possible to delete custom event fields but *not* the default event fields that are automatically provided when the event was created.

1. On the **Events and stat rules** page, under **Events**, select the name of the event that you want to change.

2. Make the changes in the **Update event** dialog.

3. Select **Save**.

[Return to the top of this topic.](#top)

## Copy an event

You can create a new event by copying an existing event and modifying its information.

1. On the **Events and stat rules** page, under **Events**, select **Copy** for the event that you want to copy.

2. Enter the **Event name** for your new event.

3. Update the description, and then add or remove the event fields as needed.

4. Select **Save** to create the event and close the dialog.

[Return to the top of this topic.](#top)

## Delete an event

> [!NOTE]
>
> * After a title passes Final Certification, existing events in that title can't be deleted.
>
> * Deleting an event deletes any chained dependencies that it might have. Before deleting an event, ensure that you also want to delete all its dependencies.
>
> * You can delete events while your title is in development but *not* after it has exited Final Certification - that is, after you've launched your title.

1. On the **Events and stat rules** page, under **Events**, select **Delete** for the event that you want to delete.

2. In the **Confirmation** dialog, select **Delete** or **Cancel**.

The following diagram shows how deleting an event deletes chained dependencies.

![Image of a diagram that shows how deleting an event deletes chained dependencies.](https://mintcdn.com/microsoft-4404708b/gzrdvT5kpqAXKEQt/images/gdk/services/event_delete_dependency.png?fit=max\&auto=format\&n=gzrdvT5kpqAXKEQt\&q=85\&s=c62fbfb172b5b3ea07af12d6aca27bf6)

[Return to the top of this topic.](#top)


## Related topics

- [Portal configuration of event-based Stats](https://devdocs.xbox.com/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-stats-eb-portal.md)
- [Events portal config (contents)](https://devdocs.xbox.com/services/xbox-services/player-data/stats-leaderboards/event-based/events/config/live-events-config-nav.md)
- [Config](https://devdocs.xbox.com/services/xbox-services/player-data/stats-leaderboards/event-based/events/config/index.md)
- [Portal configuration overview](https://devdocs.xbox.com/services/xbox-services/fundamentals/portal-config/live-portal-config-overview.md)
- [Portal configuration of event-based Leaderboards](https://devdocs.xbox.com/services/xbox-services/player-data/stats-leaderboards/event-based/config/live-eb-leaderboards-portal.md)