Triggers Tutorial

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

  • Relevant Location displays a shortcut to your pass on the user’s screen when the device is in the vicinity of certain location. The radius around the location where the shortcut appears is determined by Apple Wallet or Google Pay 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.

  • Relevant Date displays a shortcut to your pass on a user’s lock screen at a certain date and time. This is handy for certain types of passes, like Events and Boarding Passes. As with Relevant Location, the timing when the shortcut appears is determined by Apple Wallet or Google Pay and varies by pass type. Relevant Date is not supported on Coupons or Store Cards.

  • Beacons display a shortcut to your pass on the user’s screen when the device is in within the proximity range of a certain beacon.

 Note

Add a Relevant Location Trigger

You may add up to ten Relevant Locations per template.

  1. Open your mobile wallet project from the dashboard, then click 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 in the Address field, 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 passholder 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.

Add a Relevant Date/Time Trigger

  1. Open your mobile wallet project from the dashboard, then click 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 Time.
  4. 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.
  5. Click Save Changes.

Add a Beacon Trigger

Apple Wallet supports the addition of up to ten beacons per template.

  1. Open your mobile wallet project from the dashboard, then click 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 passholder 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. Open your mobile wallet project from the dashboard, then click 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.