Location-Based Pass Alerts

Set triggers to make pass-relevant text appear on a user’s lock screen based on location, date, or proximity to a beacon.

Add a Relevant Location Trigger

Display a shortcut to your pass on the user’s screen when the device is in the vicinity of a certain location. The radius around the location where the shortcut appears is determined by Apple Wallet and varies by pass type. For instance, Boarding Passes will appear on the lock screen at around 1,000m, while Coupons will appear at around 100m. You can add up to ten Relevant Locations per template.

 Important

As of August 2020, Location triggers are unavailable for all mobile devices upgraded to Google Play Services. This affects most Google Wallet passes. Google has not announced if or when they will make Location triggers available again.

  1. Go to Triggers.
  2. Click anywhere in a template’s row to see its trigger settings in the expanded view. If you have only one template in the project, the initial view is already expanded.
  3. Click Add Triggers then Add a Relevant Location.
  4. Enter an Address, then click to choose the address from the list of matches that appears. After selecting the address, its GPS coordinates will be listed next to the Location pane’s title.
  5. (Optional) Enter the Relevant Text that will appear on the lock screen when a pass holder is near the location, e.g., “Store nearby on 3rd and Main.”
     Note

    For Google passes, the Relevant Text is determined by Google, so it is not editable.

  6. (Optional) Click Add Another Location and continue with your specifications.
  7. Click Save Changes.

Location triggers can be used in combination with Date/Time Triggers.

Add a Relevant Date/Time Trigger

Display a shortcut to your pass on a user’s lock screen when the device is in the vicinity of a certain location during a certain date and time. This is handy for certain types of passes that have date and time relevancy, like Events and Boarding Passes.

  • The timing when the shortcut appears is determined by the wallet app and varies by pass type.
  • Relevant Date is not supported for Coupons or Store Cards.
  • You can use Date and Time without Location for Event passes only.
  1. Follow the steps above to set up a Relevant Location trigger.
  2. Go back to Triggers.
  3. Click anywhere in a template’s row to see its trigger settings in the expanded view. If you have only one template in the project, the initial view is already expanded.
  4. Click Add Triggers then Add a Relevant Time.
  5. Make selections for the day, time, and time zone when you want the pass to display.
    • Select a day: Use the date picker, or enter a date in MM/DD/YYYY format.
    • Select a time: Select a time from dropdown menu, or enter a time in 24-hour notation, e.g., 16:47 for 4:47 p.m.
    • Select a time zone: Select from the dropdown menu.
  6. Click Save Changes.
 Tip

You can also send notifications that link to a pass based only on date and time, and not based on location, using the API. See Schedule Notifications in Wallet Push Notifications.

Add a Beacon Trigger

Display a shortcut to your pass on the user’s screen when the device is in within the proximity range of a certain beacon. Apple Wallet supports the addition of up to ten beacons per template.

  1. Go to Triggers.
  2. Click anywhere in a template’s row to see its trigger settings in the expanded view. If you have only one template in the project, the initial view is already expanded.
  3. Click Add Triggers then Add a Beacon.
  4. Enter the beacon’s UUID and the Relevant Text that will appear on the lock screen when the pass holder is near the beacon.
  5. (Optional) Enter the beacon’s Major and Minor values.
  6. (Optional) Click Add Another Beacon and continue with your specifications.
  7. Click Save Changes.

Edit or Remove a Trigger

  1. Go to Triggers.
  2. Click anywhere in a template’s row to see its trigger settings in the expanded view. If you have only one template in the project, the initial view is already expanded.
  3. Click a trigger to highlight it, then make your desired changes, or click the X in the upper right corner of its pane to delete it.
  4. Click Save Changes.