Deep links
The deep links is a bridge between your game and the web hub environment you create with the Aghanim. When you integrate the deep links into your game, players can interact with the hub without separate authentication.
To use the deep links for player authentication:
- Embed the links within your game interface.
- Open the link page in the default browser, not in a webview.
It allows the players to discover the game hub and interact with it.
https://<GAME_HUB_DOMAIN>/go/login?player_id=<UNIQUE_PLAYER_ID><QUERY_PARAMETERS?>
https://<GAME_HUB_DOMAIN>/go/redeem?player_id=<UNIQUE_PLAYER_ID><QUERY_PARAMETERS?>
Query parameters
To customize the deep links, add the query parameters you are interested in to the link.
player_id
Required
The Player ID used to auto authenticate the player into the game hub with the game credentials.
redirect_path
Optional
The game hub page to redirect the player to. To know what value the page has, use the template: /<PAGE_PATH_IN_HUB>.
The path may also contain a # anchor pointing to the store category. However, in that case, you must URL-encode the path.
code
Required for redeem code page
A redeem code that should be applied when a player follows the link.
locale
Optional
The language to display the game hub pages with. Use the ISO 639 format representation provided in the full list of supported languages.
attributes.<key>
Optional
Arbitrary custom attributes to attach to the player on authentication. Replace <key> with your attribute name (e.g. attributes.campaign_id, attributes.utm_source). You can pass multiple custom attributes by adding several query parameters with the attributes. prefix.
Custom attributes are supported only for deep links authenticated by Player ID or Composite Player ID. They are ignored for OAuth-based authentication via the token parameter.
The keys appsflyer_id, appsflyer_app_id, adjust_device_id, and ga4_client_id are reserved for the analytics integrations (see AppsFlyer and Adjust) and are not stored as custom attributes.
Use cases
Redirecting to the News page
You can direct players to the game hub's news page, where they can read updates and potentially make purchases. Suitable locations for these links may include in-game banners, news sections, etc.
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>&redirect_path=/news
Redirecting to the specific store category
The store will open, and the page will scroll to the specified category.
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>&redirect_path=%2Fstore%23category-slug
Auto-redeeming coupons
Deep links can also be used to navigate players to a coupon redemption page within the game hub, where a predefined redeem code is automatically applied. This feature allows players to receive free items without manual code entry. Such links are ideal for promoting special offers or rewards within the game.
https://<GAME_HUB_URL>/go/redeem?player_id=<UNIQUE_PLAYER_ID>&code=<REDEEM_CODE>
When a player uses this link and the redeem code is activated, a webhook notification is sent to your specified URL. This notification confirms the code's activation, allowing you to credit the corresponding item to the player's account.
Redirecting to the localized game hub
In the deep link, you can specify the language of the game hub to redirect the player to a localized version.
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>&redirect_path=/news&locale=pt
Passing custom attributes
You can attach arbitrary custom attributes to a player on authentication by adding query parameters with the attributes. prefix. The attributes are stored with the player profile and can be used for analytics, segmentation, or personalization.
Before you can pass an attribute through a deep link, declare it in the dashboard:
- Go to Aghanim Dashboard → Game → Player attributes.
- Create a new attribute or open an existing one.
- Make sure the Allow set value in deep links toggle is enabled.
Then use the attribute key in the deep link as attributes.<key>:
https://<GAME_HUB_URL>/go/login?player_id=<UNIQUE_PLAYER_ID>&attributes.campaign_id=summer_2025&attributes.utm_source=newsletter
Next to read
Need help?
Contact our integration team at [email protected]