Yumpingo Webhooks Implementation

The Yumpingo integration harnesses the functionality of the Punchh Platforms Webhooks Module, enabling the consumption of guest data, account transactional events, and information on Redeemable updates in near real-time. They use this data for Segmentation, Targeted Surveys, and Gifting Redeemables in the Yumpingo Platform. This integration specifically utilizes the Loyalty Check-in and Redeemable events provided by Punchh's Webhooks.

Requirements

Please reach out to your Punchh representative to enable the setup and configuration.

To enable access to the Webhook sections of the Punchh Platform, the Webhooks module must be enabled for your brand (if not already enabled). 

Setup and Configuration

Step 1.

A brand's admin will need to send a location list to onboarding@yumpingo.com with the Subject: "CUSTOMER NAME: Punchh Location List". The Yumpingo engineering team will configure the Yumpingo system to accept webhook events for the provided locations. This list can be exported from the Punchh Platform following these instructions:

1. Go to Store Locations > All Store Locations.
2. Click on the three-dot menu in the right corner.
3. In the drop-down, click on Export Summary.
   
4. Enter the name and email address you would like to receive the export, and click Save Schedule.
5. Once complete, the location summary export will be sent to your email address. You can find the location keys along with the store number and other information associated with the location.

Step 2.

Reach out to integrations@yumpingo.com at Yumpingo to request a Client and Secret ID for the webhook authentication setup in the Punchh Platform.

Step 3.

Contact your Punchh representative to enable Webhooks for your brand (if not already enabled).

Step 4.

Configure the webhook in Punchh.

1. In Punchh, select Data Sharing > Outbound Webhooks in the left navigation bar.
2. Select Webhooks tab on the page.
3. Click the Base URL button in the top right.
   
4. Click on Add New URL.
   
5. Fill in the form with the following:
   
   1. Name: Yumpingo
   2. Webhook Base URL: https://webhook.yumpingo.com
   3. Admin Email: integrations@yumpingo.com
6. Click Submit

Step 5:

Create the Loyalty Check-In Webhook.

1. Return to the Webhooks tab.
2. Click the + Create Webhook button in the top right.
   
3. Fill in the following:
   
   1. Name: Loyalty Check-In
   2. Description: Enter any relevant description (used for reference)
   3. Base URL: Select Yumpingo from the drop-down
   4. Webhook End Point: /punchh/check-in
   5. Authentication: HMAC-SHA256
   6. Client:
   7. Secret:
   8. Move the Loyalty Checkin Event to Selected Events.
4. Click Submit.

Step 6:

Create the Redeemable Webhook.

1. Return to the Webhooks tab.
2. Click the + Create Webhook button in the top right.
3. Fill in the following:
   1. Name: Redeemable
   2. Description: Enter any relevant description (used for reference)
   3. Base URL: Select Yumpingo from the drop-down
   4. Webhook End Point: /punchh/redeemables
   5. Authentication: HMAC-SHA256
   6. Client: [token provided by Yumpingo Integrations]
   7. Secret: [token provided by Yumpingo Integrations]
   8. Move only the Redeemables Event to Selected Events.
4. Click Submit.