The true power of Pilgrim begins to showcase itself once you start integrating its event detection with other services. Pilgrim supports a number of server-side and third-party integration options.


Third-Party Integrations

Many teams use a Mobile Marketing Automation (MMA) solution to manage events and create content based on those events. Similar to webhooks, we will send a notification to partners you have configured every time there is an arrival or departure event. We now allow you to directly integrate the Pilgrim SDK events into the platform your company is using. If yours is not on the list, let us know and we can look into offering an integration with that as well.


Airship

Integration Details

  1. Make sure the Pilgrim SDK is properly setup.
  2. Make sure that you’ve set a user specific ID by using the setUserId method of PilgrimUserInfo in the Pilgrim SDK.
  3. From your app’s Foursquare Pilgrim Console’s Integrations settings page, add a new Airship integration:
    screenshot of adding an integration
  4. Fill in your Airship account’s App ID and App Token in your app’s Foursquare Pilgrim Console.
  5. Select the specific visit and geofence fields you wish to send to Airship:
    screenshot showing the selection of visit and geofence fields to send to Airship
  6. Once done in the Airship modal, be sure to save your changes. Once saved, the Pilgrim SDK will automatically track location events and forward them to Airship.

Braze

How We Work Together

Together, Foursquare and Braze (formerly Appboy) are powering the future of location-based engagement. Foursquare’s Pilgrim SDK delivers a hyper-accurate understanding of where your users go, and our integration with Braze means you can seamlessly personalize your users’ experiences and drive deeper engagement. Foursquare will provide real-time event triggering based upon your users’ location in the physical world, allowing you to harness our powerful geotargeting capabilities and take action with Braze.

Examples of What You Can Do

Integrating w/ Braze opens up a variety of powerful use-cases to help you personalize your users’ experiences:

  • Send customers a notification when they arrive at or leave a particular location based upon Foursquare contextual data, such as a concert venue or Home.
  • Trigger coupons or promotions for high-value customers when they arrive at a location.
  • Gather key demographic or behavioral data over time for richer retargeting.

Integration Details

  1. Make sure both Braze and Pilgrim SDKs are properly setup.
  2. In order to properly map the Braze and Foursquare SDKs, you will need to set the same user ID in both systems, using the changeUser method in the Braze SDK and the setUserId method of PilgrimUserInfo in the Pilgrim SDK.
  3. Enter your Braze REST API Key and (optionally) App IDs in to your app’s Foursquare Pilgrim Console.
  4. Once you have configured the Pilgrim Console, the Pilgrim SDK will automatically track location events and forward them to Braze, allowing you to retarget and segment your customers.
  5. See the Braze developer documentation for more details.

Iterable

How We Work Together

Iterable is a powerful cross channel customer engagement suite that, when combined with Foursquare’s Pilgrim SDK, allows you to seamlessly communicate with your users and ensure they are getting a personalized and highly engaging experience. Foursquare will provide real-time event triggering based upon your users’ location in the physical world, allowing you to harness our powerful geotargeting capabilities and take action on multiple channels with Iterable.

Examples of What You Can Do

Integrating w/ Iterable introduces new location-based engagement, segmentation and personalization:

  • Target Customers when they’re most likely to engage: Trigger targeted messages to users when they are most likely to engage with your brand, such as when they enter your store location or when they depart from a home or work location.
  • Re-capture lapsed customers or customers from competitors: Trigger targeted messages to users when they are in your competitors’ locations or send messages to customers who have strayed from your brand while they are at nearby locations.
  • Discover your customers’ personal preferences ‘in the background’: Segment your mobile users based on their real-world preferences. Pilgrim can reveal which of your users are coffee-lovers or sports-fans allowing you to engage on a deeper level. Pilgrim does this by tracking visit patterns to specific venue types and then by assigning ‘personas’ based on the meta-data associated with to those venues.

Integration Details

  1. Make sure the Pilgrim SDK is properly setup. If you are also looking to utilize Iterable’s In App Push Notification capability, you’ll also need to get the Iterable SDK setup also.
  2. Make sure that you’ve set any user specific ID in using the setUserId method of PilgrimUserInfo in the Pilgrim SDK.
  3. Enter your Iterable API Key in to your app’s Foursquare Pilgrim Console.
  4. Once you have configured the Pilgrim Console, the Pilgrim SDK will automatically track location events and forward them to Iterable, allowing you to easily engage with your users.
  5. See the Iterable developer documentation for more details.

Leanplum

How We Work Together

Leanplum is a mobile engagement platform that helps forward-looking brands meet the real-time needs of their customers. Leanplum has partnered with Foursquare to provide real-time event triggering based upon your users’ locations in the physical world, allowing you to harness our powerful geotargeting capabilities and take omni-channel action with Leanplum.

Examples of What You Can Do

Integrating with Leanplum introduces new location-based engagement, segmentation and personalization:

  • Target customers where they’re most likely to engage: Utilize accurate location awareness to target notifications to users at places where they are most likely to engage, including at specific retailers, QSRs, or even when they depart from a home or work location.
  • Capture market share from competitors: Trigger targeted messages to your users when they are near or in your competitors’ locations or send personalized offers to customers to keep them loyal to your brand.
  • Engage with your users in a more data-centric manner: Segment your mobile users based on their real-world preferences. Pilgrim can segment your users based on visit-derived algorithms to help you know if they are coffee lovers or sports fans. Pilgrim does this by tracking visit patterns to specific venue types and then by assigning ‘personas’ based on the metadata associated with those venues, all of which is actionable within the Leanplum platform.

Integration Details

  1. Make sure both Leanplum and Pilgrim SDKs are properly set up.
  2. In order to properly map the Leanplum and Foursquare SDKs, you will need to set the same user ID in both systems, using the start(withUserId) or setUserId methods (see Leanplum documentation) in the Leanplum SDK and the setUserId method of PilgrimUserInfo (see Pilgrim documentation) in the Pilgrim SDK.
  3. From your app’s Foursquare Pilgrim Console’s Integrations tab, add a new Leanplum integration:
    screenshot of adding an integration
  4. Enter your Leanplum App ID (this will be a string that starts with app_) and Client Key (this will be a string that starts with dev_ or prod_) located in the Keys & Settings section of your Leanplum account.
  5. Select the specific visit and geofence fields you wish to send to Leanplum:
    screenshot showing the selection of visit and geofence fields to send to Leanplum
  6. Once done in the Leanplum modal, be sure to save your changes. Once saved, the Pilgrim SDK will automatically track location events and forward them to Leanplum, allowing you to engage with your customers in real time.
  7. See the Leanplum developer documentation for further integration details.

Localytics

Integration Details

  1. Make sure the Pilgrim SDK is properly setup.
  2. Make sure that you’ve set any user specific ID in using the setUserId method of PilgrimUserInfo in the Pilgrim SDK.
  3. Enter your Localytics App UUID, API Key and App Secret in to your app’s Foursquare Pilgrim Console.
  4. Once you have configured the Pilgrim Console, the Pilgrim SDK will automatically track location events and forward them to Localytics, allowing you to easily engage with your users.

mParticle

Integration Details

  1. Make sure the Pilgrim SDK is properly setup.
  2. Optionally, set any user specific ID in using the setUserId method of PilgrimUserInfo in the Pilgrim SDK.
  3. Enter your relevant mParticle keys in to your app’s Foursquare Pilgrim Console.
  4. Once you have configured the Pilgrim Console, the Pilgrim SDK will automatically track location events and forward them to mParticle.

SalesForce Marketing Cloud

Integration Details

  1. Make sure the Pilgrim SDK is properly setup.
  2. Optionally, set any user specific ID in using the setUserId method of PilgrimUserInfo in the Pilgrim SDK.
  3. Enter your SalesForce MC Client ID, Client Secret and Event Definition Key in to your app’s Foursquare Pilgrim Console.
  4. Once you have configured the Pilgrim Console, the Pilgrim SDK will automatically track location events and forward them to SalesForce MC.

Next Steps

Help improve the accuracy of the Pilgrim SDK and where we think devices are located is by providing feedback about a user’s visit.

Visit Feedback

Was this page helpful?
Yes
No
Thank you!