How to generate deep invite links?

💻 Environment/Context

  • Mobile app
  • Teams & players
  • API

 

In order for you to view the API key, the Settings > Can view API key permission must be enabled on your account. 

If you're unable to follow any of the steps below, kindly 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 hides the player's identifying info (company, team and player) in a Base64 encoded string, which the app reads when the link is opened
  • Link structure: app-onboarding.scoreplay.io/index.html?welcome/{encoded_string}
  • The {encoded_string} is the Base64 encoded version of this text: {company_id}?team_id={team_id}&player_id={player_id}
  • Generate the link with an AI assistant (recommended, fastest)
  • Open the final link on a mobile device that has the ScorePlay app installed. It logs the player in automatically

 

🔖 Notes