Yelp

Yelp is a crowd-sourced local business review platform operating across 32 countries, with rich data on restaurants, cafes, and food businesses including ratings, photos, hours, and verified reviews.

MoEngage <> Yelp

The MoEngage <> Yelp integration allows you to personalise food delivery, dining, and lifestyle campaigns with nearby restaurant recommendations at send time. Common use cases include surfacing top-rated restaurants near a user's location, promoting dining options for a specific cuisine type a user prefers, or driving reservations by showing highly-rated nearby venues.

Integration

library_add_check

Prerequisites

Ensure you have a Yelp developer account with an active API key. Free keys are available at yelp.com/developers/v3/manage_app.

Step 1: Get your Yelp API key

  1. Navigate to yelp.com/developers/v3/manage_app and create a new app.
  2. Your API key is displayed immediately after app creation. Copy it.

Step 2: Set up the Content API on MoEngage

  • Navigate to Dashboard > Settings > APIs and open the Content API tab.
  • Click Add Content API.
  • Fill in the details using the table below as a reference.
Key Value
Name Choose a descriptive name, for example Yelp Nearby Restaurants.
Method GET
API URL

https://api.yelp.com/v3/businesses/search

Refer to the Yelp Fusion API documentation for all endpoints and parameters.

Headers
Header Value
Authorization Bearer YOUR_API_KEY
Key Value Parameters
Parameter Example value Notes
location @user.city City or address. Use latitude and longitude parameters instead for coordinate-based search.
categories restaurants Yelp category alias to filter results.
sort_by rating Sort order: best_match, rating, review_count, or distance.
limit 3 Number of results to return.
  • Click Validate to confirm the platform returns a response, then click Save.

Once saved, refer to the MoEngage documentation on using Content APIs in campaigns to learn how to reference response fields inside your campaign templates.

Understanding the API response

The response contains a businesses array. Each object represents one business.

Response field Template variable example Description
businesses[0].name {{ContentApi.businesses[0].name}} Business name.
businesses[0].rating {{ContentApi.businesses[0].rating}} Yelp rating out of 5.
businesses[0].review_count {{ContentApi.businesses[0].review_count}} Total number of reviews.
businesses[0].image_url {{ContentApi.businesses[0].image_url}} Business photo URL.
businesses[0].url {{ContentApi.businesses[0].url}} Yelp page URL — use as a CTA.
businesses[0].location.address1 {{ContentApi.businesses[0].location.address1}} Street address.
businesses[0].categories[0].title {{ContentApi.businesses[0].categories[0].title}} Primary category, for example "Italian".

Previous

Next

Was this article helpful?
0 out of 0 found this helpful

How can we improve this article?