User Profile

User properties and segments are available throughout the system as requirements or context for automation. However, user properties and segments are completely hidden from users. Currently, you cannot display how many XP points a user has on the Widget. This is especially important for leaderboards, where you want to present one user to another.

Where can I use it?

If you want to show internal user information to other users, you can use the User Profile feature. This feature is only available via the API but allows you to expose any user information to others.

📘

Example

For example, you can show a user's XP points, level, or completed quests to other users.

How can I configure it?

To configure the User Profile, go to the User Profile section in the Admin Panel.

You can add more fields to the User Profile by clicking the "+" button. For each field, enter two values:

• Alias: The presentation name of the field, shown to users. Must be unique.
• Property: The name of the user property or segment you want to display. You can use one property or segment for multiple fields.

After adding all the required fields, click the "Save" button. You can now use the User Profile API to retrieve user information.

By default, only one field is available in the User Profile: the user's display name (__displayName). This field will be used in the future to show the user's name in leaderboards. You can customize and use default fields as well, but you cannot delete them.

🚧

Important

All aliases starting with "__" are reserved for the system and cannot be used.