Filtering Data By Location Using Webhooks

You can use a webhook to send JSON data to Enplug. Using a LocationId, JSON data can be filtered by location to show site-specific information on a menu canvas. This eliminates the need to have a copy of your menu for each location..

Requirements

• A Professional or Enterprise Account
• JSON data file

Supported hardware and software versions:

• Nvidia Shield - Android 8, Android 9 and Android 11
• Android Legacy Player - Android 8, Android 9, Android 11: 8.1.0
• Android Native Player - Android 8, Android 9, Android 11: 81.2.5 

Note: Brightsign, Samsung Tizen, LG WebOS, or Windows players aren’t currently supported.

You’ll first need to create and connect a webhook integration. Then, you’ll use your API program to pull data from the JSON file into your integration using the webhook URL.

JSON Formatting

To utilize the device filtering feature, you’ll need to create a JSON file that will act as the data source for the webhook.

Use this template to populate the JSON file:

{
  "Products": [
    {
      "ProductId": "001",
      "LocationId": "001",
      "ProductName": "Sandwich Name of Greatness",
      "Description": "First Sandwich",
      "Category": "Lunch",
      "Calories": "1160",
      "Price": 1.50
    }
  ]
}

Notes:

• LocationId and ProductId are required fields.
• If a text string is left as a placeholder, that data category will populate, but appear blank.
• Non-required fields can be omitted.
• Use this structure for as many products as desired.

Adding the Integration to a Menu

After pulling data from the formatted JSON file into your created webhook, you can apply the integration to a menu.

To do so:

1. Return to the Enplug dashboard.
2. Click the Apps drop-down in the top menu.
3. Open the Menu Board app.
4. In the top right corner, click Product Library.
5. Open the Webhooks tab.
   • During the initial setup, you’ll click the eye icon to select visible fields.
6. Click Back To Menus.
7. In the top right corner, click Add New Menu.
8. In the top menu, click the integration icon labeled Add dynamic products from an integration.
   • Data filtering by location can only be used with dynamic lists of products.
9. After finishing the menu layout, click on the products you’ve added.
10. In the right side menu, click the Canvas drop-down.
11. Under Select Location, check the box labeled Activate Location ID to populate additional drop-down menus:
    • Integrations: This is used to select which integration to pull data from.
    • Locations: This is used to select which specific location you’d like to preview data from.
12. Click Save.

Note: Data won’t be filtered until the LocationID is assigned to a device following the steps below. 

Applying Filters to Devices

To apply location filters to your devices:

1. Return to the Enplug dashboard.
2. Click the Display Groups drop-down and select a group.
3. Click on the device you’d like to apply the filter to.
4. In Device Details, check the box labeled Set Location ID.
5. In the Location ID field, enter the corresponding ID.
   • This must match the LocationId of the JSON file.
6. Click Save.

Previewing Filters

To preview an applied filer:

1. Return to the Enplug dashboard.
2. In the left side menu, click Monitoring.
3. To the right of the device you’d like to preview, click the information icon to launch monitoring details.
4. In the top menu, click Screenshot.

This will launch a screenshot of the current display.

Note: A preview of filtered data can only be seen through the menu canvas, when filtering by the integration and location, as well as via device screenshot. The standard preview feature will show all data from all locations.

For questions or concerns, please reach out to our Support Team at support@spectrio.com.