This guide provides step-by-step instructions on how to set up the Punchh integration within the Attentive platform. Target Audience: IT, Marketing Operations, and System Administrators.

Prerequisites

Before you begin, you must have webhooks enabled in your Punchh account. Then, gather the following information from your Punchh account or representative:

• Base URL
• Business UUID
• Client ID
• Secret
• Business Admin Key (Note: This must be entered into the field labeled "API Key" in Attentive)

Coupon Ingestion: Attentive can manually ingest Punchh coupon codes. To use Punchh coupons in Attentive campaigns, create a coupon set in Punchh, export it as a CSV, and provide it to your Attentive team for manual ingestion.

Step 1: Install the Integration in Attentive

1. In Attentive, navigate to the Marketplace.
2. Find the Punchh tile using the search bar and click on it.
3. Click Install.
4. Fill out the necessary fields (Base URL, Business UUID, Client ID, Secret, API Key).
5. Click Save and continue.

Step 2: Configure Sync Features in Attentive

Navigate to Marketplace > Installed by you, click the Punchh tile, and go to the Settings tab.

1. Loyalty Event Webhooks Synchronization: Check this box to generate your webhook credentials. Copy the values in Attentive Webhook Base URL and Attentive Webhook End Point to enter into the "Webhook Base URL" and "Webhook End Point" fields on your Punchh Webhooks Manager dashboard. Checking this box and completing the installation in Punchh will enable loyalty events to flow from Punchh to Attentive.
2. Create Punchh Email Subscriptions: Check this box to automatically create email subscriptions in Attentive when a user signs up through Punchh.
3. Capture Loyalty Sign-ups Through Attentive: Check this box to allow sign-ups captured via Attentive Sign-up Units and Text-a-Keyword Journeys to pass through to Punchh. Contact your Attentive CSM or our Support team to add the loyalty checkbox to your desired SMS sign-up units
4. Enable SMS Consent Update Sync: Check this box to run a historical backfill that updates SMS subscription consent statuses. This synchronizes statuses of guests in Attentive back to Punchh.
5. Enable EMAIL Consent Update Sync: Check this box to run a historical backfill that updates EMAIL subscription consent statuses. This synchronizes statuses of guests in Attentive back to Punchh.

Step 3: Configure Webhooks in Punchh

Complete these steps with your Punchh administrator or representative to send loyalty events and profile updates to Attentive.

1. Save your settings in Attentive. After enabling Loyalty Event Webhooks Synchronization, click Save changes. Copy the generated Attentive Webhook Base URL and Attentive Webhook End Point.
2. Open Punchh’s webhook settings. In Punchh, navigate to Data Sharing → Outbound Webhooks, then open the Webhooks tab.
3. Add the webhook base URL. Click Base URL → + Add New URL. Enter the Attentive Webhook Base URL copied from Attentive and save the configuration.
4. Create the webhook. Return to the Webhooks tab and click + Create Webhook. Use the base URL you added and enter the Attentive Webhook End Point in the Webhook End Point field.
5. Configure authentication. Select Bearer as the authentication method. In the Auth Bearer Token field, enter the Punchh Business Admin Key. This must match the value entered in the API Key field of your Punchh integration settings in Attentive.
6. Select outbound events. Select the Punchh events needed for your integration. Refer to Punchh Events & Attributes Reference for supported events and their corresponding Attentive journey triggers. Save the webhook configuration.

Adding SMS Subscribers from Punchh Loyalty Forms:

Some brands want to capture new SMS opt-ins from their existing Punchh forms, including a custom mobile app, website forms, or Punchh-hosted iframe units. To do so, you must create a Custom App and use the Attentive Subscribers API 

• To add SMS subscribers via the Subscribers API, refer to our Subscribers API documentation.
• A custom app is required to generate an API key in order to use any of Attentive’s APIs. 

Troubleshooting and Support

If user attributes and events aren't appearing in Attentive after enabling webhooks:

1. Locate the 'Platform Function API Base URL (optional)' field on the Settings tab for the Punchh integration in Attentive.
2. If your Base URL uses the US-West domain (e.g., https://hooks.us-west.punchh.com), you must add the corresponding dashboard API URL (e.g., https://dashboard-api.us-west.punchh.com) as the Platform Function API Base URL.
3. Support & Escalation: For questions about an Attentive campaign, feature, or integration troubleshooting within Attentive, connect with your Attentive contact or Support.