The Pilgrim Console allows you to remotely configure how the SDK will respond to different visit events and control the flow of information to a webhook or third party. The sections below provide further detail on configuring your Pilgrim Console for success.
Accessing your Console
After your API key is whitelisted, access the Pilgrim console here (where
CLIENT_ID is the Client ID for your Pilgrim app):
You can also click into the console from your app’s main landing page (
https://foursquare.com/developers/app/CLIENT_ID) by scrolling to the bottom of the page > click on Pigrim Configuration.
Please remember to click the Save Changes button at the top of the page to save updates.
The Snap-to-Place tab is where you can control high-level events for which you would like to receive from the SDK.
You can choose to be notified for all venues or filter for a subset of venues based on categories, chains, and/or a specific venue. Please note that if you are filtering by a specific venue, you will need to select the geographical location first.
By default, the Minimum Confidence Level is set at All but the drop-down menu can be adjusted. Read more about confidence levels here.
After 3-7 days of use, the SDK will determine the user’s home and work location. If you would like to see these events, you can enable the Include events for Home stops and Include events for Work stops checkboxes. Read more about home/work stops here.
If you would like to know when a user leaves a venue, please enable Include exit events.
Enable Include other probable venues if you want to receive an object of nearby venues. Please note that if the minimum confidence level is not met for the nearby venues, then the nearby venue will not be triggered. When using this setting, we recommend setting the Minimum Confidence Level to All. Read more about nearby venues here.
Pilgrim SDK allows geofencing around a configurable set of venues. Geofences can be set for the venues, categories, or chains of your choosing. Learn more about geofences here.
In addition to regular callbacks from our SDK, you can also set up webhooks so we can send an event to your servers any time one of your users arrive at a venue.
Read more about webhooks here.
Pilgrim supports a number of third-party integration options such as Braze and mParticle. Learn more about configuration options here.
Now that you are familiar with the Pilgrim Console, here are additional resources that can help you successfully integrate with Pilgrim: