Yelp integration for Mixmax

This integration allows you to use a /yelp slash command to integrate a Yelp business listing along with a clickable outbound link to the business' Yelp page.

This is an open source Mixmax Slash Command. See Mixmax slash command for more information on building integrations in Mixmax.

Demo

After following the setup instructions below, you should be able to trigger the integration with the /yelp command in your email client. It should look like this:

Setup and running locally

1. Make a copy of /utils/_yelp.js as /utils/yelp.js. Register a Yelp developer API key here and fill in the necessary fields
2. Install dependencies using npm i
3. Run server using npm start

Why do we run it in https locally?

Mixmax slash command APIs are required to be served over https. This is because they are queried directly from the Mixmax client in the browser (using AJAX) that's running on an HTTPS domain. Browsers forbid AJAX requests from https domains to call http APIs, for security. So we must run an https server with a locally-signed certificate.

Adding the slash command in Mixmax

1. Go to your Mixmax integration settings panel
2. Click Add Slash Command and enter the following values: <img src="resources/slash_command.png") width="438">

Detailed instructions can be found here.