Learn how to create deep links that open directly to a specific screen or record within your PocketPlatform app.

1. You have a "customer slug", which is a short, unique identifier used in API URLs.
   The format looks like this: https://{customer-slug}.api.pocketplatform.io/v2/navigation
2. To open your navigation file, copy the link and replace {customer-slug} with your church's slug. Then paste that link into your browser, and press Enter.
   Your navigation file displays. It contains every screen and path available within your app.

3. Search the navigation file for the name of the screen. The <path> element tells you the route that PocketPlatform uses inside the app.
   If you want to link to the event registration screen, search for "register". Your path would be register.

   

   If you want to link to self check-in, search for "checkin". Your path would be self_checkin.

   

4. In MinistryPlatform, open the record for your target item (such as the Event record or Opportunity record). Note the ID number of this record.

5. Using the information you gathered, build your deep link in this format: {customer-slug}://{path}/{id}

   Gathered Information	Resulting Deep Link
   Customer slug is mychurch Want to link to registration screen Event record ID is 123	mychurch://register/123
   Customer slug is mychurch Want to link to serving opportunity screen Opportunity record ID is 99	mychurch://opportunity/99
   Customer slug is mychurch Want to link to a list List record ID is 42	mychurch://lists/42
   Customer slug is mychurch Want to link to self check-in Event record ID is 1001	mychurch://self_checkin/1001

6. Copy the deep link you built using your information.

7. Paste the link into an email, text message, or note on your mobile device where the app is installed.
8. Tap the link.
   The link should open in the PocketPlatform app on your device.
9. Double-check that the screen, record ID, and permissions all match what you expect.