home

MinistryPlatform

RealmMinistryPlatformPDSACSAccountingGivingConnectShepherdGrowth MethodGo MethodMissionInsiteGatherHeadMaster ChildcareTrust Center
RealmMinistryPlatformPDSACSAccountingGivingConnectShepherdGrowth MethodGo MethodMissionInsiteGatherHeadMaster ChildcareTrust Center

What would you like to know more about?

Show Contents

thumbnailMinistryPlatform

PocketPlatform

Create & Send Deep Links

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

What is a deep link? A deep link is a special URL that opens your church's mobile app directly to a specific screen. Deep links make it easy to send people straight into the app experience from an email, text message, or your website. These links are perfect for promoting events, volunteer opportunities, or check-in options directly inside the app!

You can direct app users to a screen in your app using your "customer slug" and the path listed in your navigation file.
Note: In order for deep links to open correctly, your app must be installed on the user's device. Otherwise, the link will not resolve properly.
Open your navigation file:
  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.
Find the screen and record you want to link to:
  1. 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.

    Example of the navigation file showing the EventRegistrationScreen component path

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

    Example of the navigation file showing the SelfCheckInScreen component path

  2. In MinistryPlatform, open the record for your target item (such as the Event record or Opportunity record). Note the ID number of this record.
Build your deep link:
  1. Using the information you gathered, build your deep link in this format: {customer-slug}://{path}/{id}
    Gathered InformationResulting 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
  2. Copy the deep link you built using your information.
Test your link:
  1. Paste the link into an email, text message, or note on your mobile device where the app is installed.
  2. Tap the link.
    The link should open in the PocketPlatform app on your device.
  3. Double-check that the screen, record ID, and permissions all match what you expect.

Your link is ready to send to app users! Copy the link again and paste it into the email, text message, or other communication you want to send.

Send Deep Links in a Push Notification

You can include deep links in PocketPlatform push notifications. This way, app users can be directed to a specific screen in the app when they tap the notification. For example, you may want a notification to take users directly to a reading plan, registration, or opportunity.

  1. Create your push notification as usual.
    1. In the navigation menu, click Administration > Users.
    2. If you want to send to only certain users, make a selection.
    3. From the Tools menu, select Send Push Notifications.
      Note: If you don't see this option in the list, you'll need to add the tool to the Tools Permitted tab for the appropriate security role.
    4. Enter a title for the notification and your message. It may be helpful to indicate that tapping the notification will open a specific screen. For example, you could include something like "Tap here for info!" or "Tap to register!".
    5. Important: Set the scheduled date to sometime in the future, such as tomorrow. This allows you time to edit the push notification records before they are sent. You'll be able to change the date and time in a later step.
    6. If you want to send to all app users (or you made a selection but changed your mind), select the option to send your message as a global notification.
    7. Click Send Push Notification.
    Push notification records are created for the selected users (one per user).
  2. Build your deep link.
    1. Open your navigation file by copying this URL https://{customer-slug}.api.pocketplatform.io/v2/navigation and replacing {customer-slug} with your church's unique identifier.
    2. When your navigation file displays, search for the screen you want to link to. The <path> element tells you the route that PocketPlatform uses inside the app. This will be the first part of your deep link.
      • If you want to link to a reading plan, your path would be reading_plan.
      • If you want to link to an event registration, your path would be register.
      • If you want to link to an opportunity, your path would be opportunity.
    3. The second part of your deep link is the specific record to open. In MinistryPlatform, open the record for your target item (such as the Reading Plan, Event, or Opportunity record).
    4. Build your deep link in this format: {path}/{id}
      • The deep link for a specific reading plan would look like this: reading_plan/3
      • The deep link for a specific event registration would look like this: register/123
      • The deep link for a specific opportunity would look like this: opportunity/20
  3. Bulk edit the push notification records to include your deep link.
    1. In the navigation menu, click PocketPlatform Lookups > Push Notifications.
    2. Select the push notifications you want to add the deep link to.
    3. From the Actions menu, select Assign.
    4. Select the checkbox for Action, and enter io.pocketplatform.app_path (exactly as shown; do not replace "app_path" with your customer slug).
    5. Select the checkbox for Payload, and enter the {path}/{id} from your deep link. You do not need to include the {customer-slug}:// part of the deep link.

      Example showing the Mass Assign modal with the checkbox beside the Action field selected and the text "io.pocketplatform.app_path" entered below it, and the checkbox beside Payload field selected and the text "register/123" entered below it

    6. If needed, you can change the Scheduled Date as well. To send it immediately, select the current date and time.
    7. Click Assign.
    8. Click Ok to confirm your updates.

Your push notifications are sent. When the recipient taps the push notification on their device, the app opens directly to the specified screen.

Remember, app users must allow push notifications on their mobile device. Otherwise, neither a selection nor global push will be delivered to their device.

The push notifications network is not instantaneous. It may take up to 15 minutes after you send the notification for it to be delivered to user devices.

After sending, you can find Push Notification records under PocketPlatform Lookups > Push Notifications.

portal
PocketPlatform

Last updated: November 14, 2025

Related Articles: