💻 Environment/Context
- Teams
- Players
- Onboarding
- Deep links
- Mobile App
In order for you to view the API key, the Settings> Can view API key permission should be enabled on your account.
If you don't see it, reach out to your admin or refer to the Account Type Permissions Overview article for more information.
❓ Issue/Question
- How do we generate a deep invite link that logs a player directly into the ScorePlay app, without asking them to manually enter an invite code?
👌 Resolution/Answer
- A deep invite link works by hiding the player's identifying info (company, team, player) inside a Base64-encoded string, which the app reads when the link is opened.
- Link structure: https://app-onboarding.scoreplay.io/index.html?welcome/{encoded_string}
- The
{encoded_string}is just a Base64-encoded version of this plain text:
{company_id}?team_id={team_id}&player_id={player_id}.
- Ask to the AI of your preference to do it for you (recommended, fastest) (ChatGPT/Gemini/Claude, etc).
- Get the player's company_id, team_id, and player_id. (see notes below for how to get these via API).
- Send the AI a message like: "Encode this string in Base64 and give me the full onboarding link:
{company_id}?team_id={team_id}&player_id={player_id}, using the base URLhttps://app-onboarding.scoreplay.io/index.html?welcome/" - The AI will return the encoded string and the ready-to-use link.
- Open the final link on a mobile device that has the ScorePlay app installed. It should log the player in automatically. Opening it on desktop or without the app installed will just show the web onboarding page instead.