Configure Server Webhooks

In the standard integration of the Movement SDK, the SDK will call your app with a notification that your user has arrived at a place. From there, it is likely that you will take some/all of the pieces of information that are handed to you and send those up to your servers for logging or other actions like notification sending. This is a good flow for most apps, but does require the upfront work of defining the client/server protocol to get this information up from your application. To get around this, Foursquare offers the ability to have your servers called anytime one of your users arrives at a place.

Some possible benefits:

  • Reduced mobile network traffic and potential battery savings for your users via cutting out an API request to your servers from the device.
  • Faster development iteration on your side without having to deploy a new app version.
  • Allows Foursquare to potentially offer new data to you without requiring an app or SDK update.

Important:
Webhooks get triggered in addition to the regular callback in the SDK and don't alter SDK behavior at all.

Setup

To setup server webhooks:

  1. From the Developer Console Home page, select the appropriate project.
  2. On the project Settingspage, click Webhooks under the Movement SDK section.
  3. On the Movement SDK Webhookpage, input your server URL where we will send a POST request with the event details.
  4. Click Save.

For each arrival, departure, and geofence event, we will send a POST request with details about the event. We will also include the secret key provided in your Developer Console so you know it's us.

Payload

The notification will come to your server endpoint as an application/json POST request. Examples are available below.

Headers

ParamValueDescription
Content-LengthIntegerSize of body content in bytes. Example: 708
Content-TypeStringWill be: application/json
Pilgrim-SecretStringA unique string that will be included on every request. You can find your secret in the developer console on the Pilgrim page.
User-AgentStringThe payload's user agent will now be: Foursquare-PilgrimSDK/$version. Example: Foursquare-PilgrimSDK/2.0
X-Forwarded-ForIP AddressExample: 199.38.179.113
X-Forwarded-ProtoStringExample: https

Visit Body

KeyTypeDescription
pilgrimVisitIdStringThe unique ID of the visit.
eventTypeStringThe visit event type. One of: placeArrival, placeDeparture, placeHistorical
timestampLongTime of the event in milliseconds since epoch.
placeEventJSON HashContains the venue and any associated visit event information.
latDoubleThe latitude of the user when they arrived at the place.
lngDoubleThe longitude of the user when they arrived at the place.
userJSON HashIf set in the SDK, contains a user and arbitrary information about that user.
installIdStringThe unique ID created by Pilgrim for each installation.
sdkTypeStringThe SDK that generated the notification iossdk or androidsdk.
sdkBuildStringThe SDK build version.
segmentsJSON HashIf enabled, contains any segments that the user belongs to.
userStateJSON HashIf enabled, contains any user states.

Geofence Body

KeyTypeDescription
eventTypeStringThe triggered geofence event type. One of: geofenceEnter, geofenceDwell, geofencePresence, geofenceExit
timestampLongTime of the event in milliseconds since epoch.
geofenceEventJSON HashContains the geofence and any associated geofence event information.
latDoubleThe latitude of the user when they arrived at the place.
lngDoubleThe longitude of the user when they arrived at the place.
userJSON HashIf set in the SDK, contains a user and arbitrary information about that user.
installIdStringThe unique ID created by Pilgrim for each installation.
sdkTypeStringThe SDK that generated the notification iossdk or androidsdk.
sdkBuildStringThe SDK build version.

Journeys Body

KeyTypeDefinition
journeyIdStringThe unique ID of the Journey.
eventTypeStringThe Journey event type. One of: journeysInProgress, journeysApproaching, journeysArrived, journeysCompleted, journeysCanceled
startTimeLongTime the journey started in milliseconds since epoch.
lastUpdatedLongTime the journey was last updated in milliseconds since epoch.
statusStringThe Journey status type. One of: journeysInProgress, journeysApproaching, journeysArrived, journeysCompleted, journeysCanceled
etaLongTime the estimated arrival time of the journey in milliseconds since epoch.
installIdStringThe unique ID created by Pilgrim for each installation.
pathArrayAn array of ll objects & a timestamp.
confirmedArrivalBooleanTrue or false based on confirmation of the user's arrival at destination.
venuesArray <Venue>The venue the user is at. Currently, a max of 1 item is sent.
categoriesArray < Category>A list of categories.
destinationArray < Venue>The destination venue. Currently, a max of 1 item is sent.
userJSON HashIf set in the SDK, contains a user and arbitrary information about that user.

placeEvent

KeyTypeDescription
venuesArray<Venue>The venue the user is at. Currently, a max of 1 item is sent.
arrivalTimelongTime of the arrival in milliseconds since epoch
departureTime (optional)longTime of the departure in milliseconds since epoch. Available on exit and historical visit types.
confidenceStringThe venue confidence, which is one of: none, low, med, high
locationTypeStringThe type of place the event corresponds to, which is one of: venue, home, work, none, unknown
otherPossibleVenues (optional)Array<Venue>A list of other venues that the device might be at. Only returned with placeArrival events and if you have the checkbox selected in the Pilgrim console

geofenceEvent

KeyTypeDescription
eventTypeStringThe triggered geofence event type. One of: geofenceEnter, geofenceDwell, geofencePresence, geofenceExit
eventLatDoubleThe latitude of the user when the geofence was triggered.
eventLngDoubleThe longitude of the user when the geofence was triggered.
radiusLongThe geofence radius.
geofenceIdStringThe unique ID of the geofence.
geofencePropertiesJSON HashContains any arbitray information about the geofence. You must set this via the Pilgrim SDK Configuration in the Developer Console.
venueIdStringThe Foursquare ID of the nearest venue to the user when the geofence was triggered.
categoryIdsArray<Category>A list of categories.
chainIdsArray<Chain>A list of chain ids.
partnerVenueIdStringThe partner id from the venue harmonization process.
venuesArray<Venue>The venue the user is at. Currently, a max of 1 item is sent.

Venue

KeyTypeDescription
idStringThe venue id
nameStringThe venue name
locationLocationThe location of the venue
categoriesArray<Category>The categories of the venue
probabilityDoubleLikelihood of this being the venue the device is actually at
hierarchy (optional)Array<Venue>The parent venues of this place, containing a subset of venue information (id, name, categories)
venueChains (optional)Array<Chain>The chains for which the venue belongs

Location

KeyTypeDescription
addressStringThe address of the venue
crossStreetStringVenue cross street
cityStringThe city of the venue
stateStringThe state of the venue
postalCodeStringThe postal code of the venue
countryStringThe country of the venue
latDoubleThe latitude of the venue center
lngDoubleThe longitude of the venue center

Category

KeyTypeDescription
idStringThe category id
nameStringThe category name
shortNameStringThe shortened version of the category name i.e. American vs American Restaurant
pluralNameStringThe plural name of the categories
iconIconThe category icon

Icon

KeyTypeDescription
prefixStringURL prefix
suffixStringURL suffix

Chain

KeyTypeDescription
idStringThe chain id

Examples

The following examples are also available for download.

Visits

{
  "pilgrimVisitId": "4c4763f7646e38002cc51789",
  "eventType": "placeArrival",
  "timestamp": 1548182419000,
  "placeEvent": {
    "venues": [
      {
        "id": "52af211911d2aa9d4a1f0e0a",
        "name": "Foursquare Chicago",
        "location": {
          "address": "20 W Kinzie St",
          "crossStreet": "at N State St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60606",
          "country": "US",
          "lat": 41.889264,
          "lng": -87.628911
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d125941735",
            "name": "Tech Startup",
            "pluralName": "Tech Startups",
            "shortName": "Tech Startup",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/shops/technology_",
              "suffix": ".png"
            },
            "primary": true
          }
        ],
        "hierarchy": [
          {
            "id": "577d3752498e0faef85a21c2",
            "name": "WeWork Kinzie",
            "categories": [
              {
                "id": "4bf58dd8d48988d174941735",
                "name": "Coworking Space",
                "pluralName": "Coworking Spaces",
                "shortName": "Coworking Space",
                "icon": {
                  "prefix": "https://ss3.4sqi.net/img/categories_v2/building/office_coworkingspace_",
                  "suffix": ".png"
                },
                "primary": true
              }
            ]
          }
        ],
        "venueChains": [
          {
            "id": "556e5779bd6a82902e28bcea",
            "name": "Foursquare"
          }
        ],
        "probability": 0.33320653250353993
      }
    ],
    "otherPossibleVenues": [
      {
        "id": "577d3752498e0faef85a21c2",
        "name": "WeWork Kinzie",
        "location": {
          "address": "20 W Kinzie St",
          "crossStreet": "at N Dearborn St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60654",
          "country": "US",
          "lat": 41.889511244213416,
          "lng": -87.62894332408905
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d174941735",
            "name": "Coworking Space",
            "pluralName": "Coworking Spaces",
            "shortName": "Coworking Space",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/building/office_coworkingspace_",
              "suffix": ".png"
            },
            "primary": true
          }
        ],
        "venueChains": [
          {
            "id": "5569f639a7c8896abe7cb706",
            "name": "WeWork"
          }
        ]
      },
      {
        "id": "5b0489c9b54618002cb921ee",
        "name": "Compass Regional HQ",
        "location": {
          "address": "20 W Kinzie St Fl 15",
          "crossStreet": "N State St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60654",
          "country": "US",
          "lat": 41.889252,
          "lng": -87.62892
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d124941735",
            "name": "Office",
            "pluralName": "Offices",
            "shortName": "Office",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/building/default_",
              "suffix": ".png"
            },
            "primary": true
          },
          {
            "id": "5032885091d4c4b30a586d66",
            "name": "Real Estate Office",
            "pluralName": "Real Estate Offices",
            "shortName": "Real Estate",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/shops/realestate_",
              "suffix": ".png"
            }
          }
        ],
        "hierarchy": [
          {
            "id": "4bbf57a082a2ef3b7a972cd2",
            "name": "20 W. Kinzie Building",
            "categories": [
              {
                "id": "4bf58dd8d48988d130941735",
                "name": "Building",
                "pluralName": "Buildings",
                "shortName": "Building",
                "icon": {
                  "prefix": "https://ss3.4sqi.net/img/categories_v2/building/default_",
                  "suffix": ".png"
                },
                "primary": true
              }
            ]
          }
        ],
        "probability": 0.09861296257083949
      },
      {
        "id": "59518d9706fb6023d22a9ad7",
        "name": "Southern Cut Barbeque",
        "location": {
          "address": "20 W Kinzie St",
          "crossStreet": "",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60654",
          "country": "US",
          "lat": 41.889384,
          "lng": -87.628605
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d1df931735",
            "name": "BBQ Joint",
            "pluralName": "BBQ Joints",
            "shortName": "BBQ",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/bbqalt_",
              "suffix": ".png"
            },
            "primary": true
          }
        ],
        "probability": 0.04432434057492494
      }
    ],
    "confidence": "high",
    "locationType": "venue",
    "arrivalTime": 1548182419000
  },
  "lat": 41.889303,
  "lng": -87.628898,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "userStates": [
    {
      "name": "travel",
      "properties": {}
    }
  ],
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2",
  "segments": [
    {
      "segmentId": 162,
      "name": "The Foursquare Coffee Drinker - U.S."
    }
  ]
}
{
  "pilgrimVisitId": "4c4763f7646e38002cc51789",
  "eventType": "placeDeparture",
  "timestamp": 1548201189000,
  "placeEvent": {
    "venues": [
      {
        "id": "52af211911d2aa9d4a1f0e0a",
        "name": "Foursquare Chicago",
        "location": {
          "address": "20 W Kinzie St",
          "crossStreet": "at N State St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60606",
          "country": "US",
          "lat": 41.889264,
          "lng": -87.628911
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d125941735",
            "name": "Tech Startup",
            "pluralName": "Tech Startups",
            "shortName": "Tech Startup",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/shops/technology_",
              "suffix": ".png"
            },
            "primary": true
          }
        ],
        "hierarchy": [
          {
            "id": "577d3752498e0faef85a21c2",
            "name": "WeWork Kinzie",
            "categories": [
              {
                "id": "4bf58dd8d48988d174941735",
                "name": "Coworking Space",
                "pluralName": "Coworking Spaces",
                "shortName": "Coworking Space",
                "icon": {
                  "prefix": "https://ss3.4sqi.net/img/categories_v2/building/office_coworkingspace_",
                  "suffix": ".png"
                },
                "primary": true
              }
            ]
          }
        ],
        "venueChains": [
          {
            "id": "556e5779bd6a82902e28bcea",
            "name": "Foursquare"
          }
        ]
      }
    ],
    "confidence": "high",
    "locationType": "venue",
    "arrivalTime": 1548182419000,
    "departureTime": 1548201189000
  },
  "lat": 41.887604,
  "lng": -87.629599,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "userStates": [
    {
      "name": "travel",
      "properties": {}
    }
  ],
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2",
  "segments": [
    {
      "segmentId": 162,
      "name": "The Foursquare Coffee Drinker - U.S."
    }
  ]
}
{
  "pilgrimVisitId": "4c4763f7646e38002cc51789",
  "eventType": "placeHistorical",
  "timestamp": 1548202432000,
  "placeEvent": {
    "venues": [
      {
        "id": "52af211911d2aa9d4a1f0e0a",
        "name": "Foursquare Chicago",
        "location": {
          "address": "20 W Kinzie St",
          "crossStreet": "at N State St",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60606",
          "country": "US",
          "lat": 41.889264,
          "lng": -87.628911
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d125941735",
            "name": "Tech Startup",
            "pluralName": "Tech Startups",
            "shortName": "Tech Startup",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/shops/technology_",
              "suffix": ".png"
            },
            "primary": true
          }
        ],
        "hierarchy": [
          {
            "id": "577d3752498e0faef85a21c2",
            "name": "WeWork Kinzie",
            "categories": [
              {
                "id": "4bf58dd8d48988d174941735",
                "name": "Coworking Space",
                "pluralName": "Coworking Spaces",
                "shortName": "Coworking Space",
                "icon": {
                  "prefix": "https://ss3.4sqi.net/img/categories_v2/building/office_coworkingspace_",
                  "suffix": ".png"
                },
                "primary": true
              }
            ]
          }
        ],
        "venueChains": [
          {
            "id": "556e5779bd6a82902e28bcea",
            "name": "Foursquare"
          }
        ]
      }
    ],
    "confidence": "high",
    "locationType": "venue",
    "arrivalTime": 1548182419000,
    "departureTime": 1548201189000
  },
  "lat": 41.887604,
  "lng": -87.629599,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2",
  "segments": [
    {
      "segmentId": 162,
      "name": "The Foursquare Coffee Drinker - U.S."
    }
  ]
}
{
  "pilgrimVisitId": "4c4b64fdd807ee002cba1560",
  "eventType": "placeArrival",
  "timestamp": 1548444925000,
  "placeEvent": {
    "venues": [],
    "confidence": "high",
    "locationType": "work",
    "arrivalTime": 1548444925000
  },
  "lat": 41.889282,
  "lng": -87.62858,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2",
  "segments": [
    {
      "segmentId": 162,
      "name": "The Foursquare Coffee Drinker - U.S."
    }
  ]
}

Geofences

{
  "eventType": "geofenceEnter",
  "timestamp": 1545078269223,
  "geofenceEvent": {
    "eventType": "entrance",
    "eventLat": 41.8893897,
    "eventLng": -87.6297896,
    "radius": 100.0,
    "geofenceId": "5c649335af2c3c526c06a898",
    "geofenceProperties": {
      "customGeofenceKey": "Custom Geofence Value"
    },
    "venueId": "4a9037fef964a5209b1620e3",
    "categoryIds": "4bf58dd8d48988d1e0931735",
    "chainIds": "",
    "partnerVenueId": "",
    "venues": [
      {
        "id": "4a9037fef964a5209b1620e3",
        "name": "Einstein Bros Bagels",
        "location": {
          "address": "400 N Dearborn St",
          "crossStreet": "",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60654",
          "country": "US",
          "lat": 41.8893897,
          "lng": -87.6297896
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d179941735",
            "name": "Bagel Shop",
            "pluralName": "Bagel Shops",
            "shortName": "Bagels",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/bagels_",
              "suffix": ".png"
            }
          },
          {
            "id": "4bf58dd8d48988d1e0931735",
            "name": "Coffee Shop",
            "pluralName": "Coffee Shops",
            "shortName": "Coffee Shop",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/coffeeshop_",
              "suffix": ".png"
            }
          }
        ],
        "venueChains": [
          {
            "id": "556ce8d9aceaff43eb0588d6",
            "name": "Einstein Bros."
          }
        ]
      }
    ]
  },
  "lat": 41.88928251303856,
  "lng": -87.62870316744883,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2"
}
{
  "eventType": "geofenceDwell",
  "timestamp": 1545078408140,
  "geofenceEvent": {
    "eventType": "dwell",
    "eventLat": 41.8893897,
    "eventLng": -87.6297896,
    "radius": 100.0,
    "geofenceId": "5c649335af2c3c526c06a898",
    "geofenceProperties": {
      "customGeofenceKey": "Custom Geofence Value"
    },
    "venueId": "4a9037fef964a5209b1620e3",
    "categoryIds": "4bf58dd8d48988d1e0931735",
    "chainIds": "",
    "partnerVenueId": "",
    "venues": [
      {
        "id": "4a9037fef964a5209b1620e3",
        "name": "Einstein Bros Bagels",
        "location": {
          "address": "400 N Dearborn St",
          "crossStreet": "",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60654",
          "country": "US",
          "lat": 41.8893897,
          "lng": -87.6297896
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d179941735",
            "name": "Bagel Shop",
            "pluralName": "Bagel Shops",
            "shortName": "Bagels",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/bagels_",
              "suffix": ".png"
            }
          },
          {
            "id": "4bf58dd8d48988d1e0931735",
            "name": "Coffee Shop",
            "pluralName": "Coffee Shops",
            "shortName": "Coffee Shop",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/coffeeshop_",
              "suffix": ".png"
            }
          }
        ],
        "venueChains": [
          {
            "id": "556ce8d9aceaff43eb0588d6",
            "name": "Einstein Bros."
          }
        ]
      }
    ]
  },
  "lat": 41.889335266663636,
  "lng": -87.62856037188838,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2"
}
{
  "eventType": "geofencePresence",
  "timestamp": 1549553712000,
  "geofenceEvent": {
    "eventType": "presence",
    "eventLat": 41.8893897,
    "eventLng": -87.6297896,
    "radius": 100.0,
    "geofenceId": "5c649335af2c3c526c06a898",
    "geofenceProperties": {
      "customGeofenceKey": "Custom Geofence Value"
    },
    "venueId": "4a9037fef964a5209b1620e3",
    "categoryIds": "4bf58dd8d48988d1e0931735",
    "chainIds": "",
    "partnerVenueId": "",
    "venues": [
      {
        "id": "4a9037fef964a5209b1620e3",
        "name": "Einstein Bros Bagels",
        "location": {
          "address": "400 N Dearborn St",
          "crossStreet": "",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60654",
          "country": "US",
          "lat": 41.8893897,
          "lng": -87.6297896
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d179941735",
            "name": "Bagel Shop",
            "pluralName": "Bagel Shops",
            "shortName": "Bagels",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/bagels_",
              "suffix": ".png"
            },
            "primary": true
          },
          {
            "id": "4bf58dd8d48988d1e0931735",
            "name": "Coffee Shop",
            "pluralName": "Coffee Shops",
            "shortName": "Coffee Shop",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/coffeeshop_",
              "suffix": ".png"
            }
          }
        ],
        "venueChains": [
          {
            "id": "556ce8d9aceaff43eb0588d6",
            "name": "Einstein Bros."
          }
        ]
      }
    ]
  },
  "lat": 41.889356,
  "lng": -87.628725,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2"
}
{
  "eventType": "geofenceExit",
  "timestamp": 1545091987992,
  "geofenceEvent": {
    "eventType": "exit",
    "eventLat": 41.8893897,
    "eventLng": -87.6297896,
    "radius": 100.0,
    "geofenceId": "5c649335af2c3c526c06a898",
    "geofenceProperties": {
      "customGeofenceKey": "Custom Geofence Value"
    },
    "venueId": "4a9037fef964a5209b1620e3",
    "categoryIds": "4bf58dd8d48988d1e0931735",
    "chainIds": "",
    "partnerVenueId": "",
    "venues": [
      {
        "id": "4a9037fef964a5209b1620e3",
        "name": "Einstein Bros Bagels",
        "location": {
          "address": "400 N Dearborn St",
          "crossStreet": "",
          "city": "Chicago",
          "state": "IL",
          "postalCode": "60654",
          "country": "US",
          "lat": 41.8893897,
          "lng": -87.6297896
        },
        "categories": [
          {
            "id": "4bf58dd8d48988d179941735",
            "name": "Bagel Shop",
            "pluralName": "Bagel Shops",
            "shortName": "Bagels",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/bagels_",
              "suffix": ".png"
            }
          },
          {
            "id": "4bf58dd8d48988d1e0931735",
            "name": "Coffee Shop",
            "pluralName": "Coffee Shops",
            "shortName": "Coffee Shop",
            "icon": {
              "prefix": "https://ss3.4sqi.net/img/categories_v2/food/coffeeshop_",
              "suffix": ".png"
            }
          }
        ],
        "venueChains": [
          {
            "id": "556ce8d9aceaff43eb0588d6",
            "name": "Einstein Bros."
          }
        ]
      }
    ]
  },
  "lat": 41.88709567122635,
  "lng": -87.63105850113463,
  "user": {
    "adid": "40C23EBD-E21A-4ACC-A915-B1C80BDAF4FE",
    "userId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4"
  },
  "installId": "CB25EFFB-C2B2-4E0F-B0E9-55C05BEFA4D4",
  "sdkType": "iossdk",
  "sdkBuild": "2.4.2"
}

Testing

If you do not already have webhook ingestion set up, you can easily use a tool called ngrok, which can be used to create a tunnel to monitor activity on your local dev machine. We also recommend using RequestInspector or http://req if you're testing outside of a webhook you own.

Important:
We no longer recommend using requestb.in, as we've noticed that sometimes pings are not delivered.-->