Punchh

Punchh is an industry-leading loyalty and engagement platform that enables brands to deliver omnichannel customer loyalty programs both in-store and digitally.

The Braze and Punchh integration allows you to sync data for gifting and loyalty purposes across the two platforms. Data published in Braze will be available for segmentation and can sync user data back into Punchh via Braze webhooks.

What are the benefits?

• Ingest loyalty data from Punchh to Braze in real-time.
• Leverage and layer powerful audience data from Braze to deliver meaningful and dynamic cross-channel experiences (app, mobile, web, email, and SMS)
  • Did customers open emails? Did customers open the app near a store?
• Standardize the look and feel of transactional emails sent through Braze.
• Create journeys that allow for A/B testing and optimization as you go.

Prerequisites

What else should I know?

Before integrating

• When utilizing the Braze integration, two campaigns will be required, one in Punchh and the second in Braze. For example, if you send a campaign with an offer attached, the gifting campaign will be configured within Punchh, and the notification can be sent from Braze.
• Guests should already exist in Punchh and Braze. Punchh will filter out any customer who is not already a loyalty guest.

Important things to note

• Punchh has added the ability to disable the sending of default user attributes to Braze, so the customer does not incur data point overages. This is configured during the adapter setup.
• If using custom segments on recurring campaigns, the campaign name must be used instead of the campaign ID, as the IDs change each time the campaign runs.
• Communication channels available within each Punchh gifting campaign include rich messages, push notifications, SMS, and email.
• Once users have been sent to a Punchh custom segment from Braze, they can’t be removed. Only new guests can be added to an existing custom segment. If guests need to be removed from an existing Punchh custom segment, a new webhook campaign will need to be created in Braze to send users to a new Punchh custom segment.

Integration

Punchh offers several endpoints available to Braze customers to help add external IDs to the Punchh platform using the following Punchh API endpoints. Once the external IDs have been added, create an adapter in Punchh, provide your Braze credentials, and select which events you’d like to sync. Next, you can take the Punchh segment ID and use it to build a Punchh webhook to trigger customer syncing in a Canvas journey.

Note that the Punchh user_id will need to be added to the Braze user profile as a custom attribute “punchh_user_id” for the integration to be used. Similarly, the external_id being used in Braze will need to be included as an external_source_id field on the Punchh user profile.

Step 1: Set up external ID ingestion endpoints

External IDs from Braze can be added using the following endpoints for new and existing Punchh users.

1. New Punchh users
   Create new users in Punchh with a Punchh sign-up endpoint using the external_source and external_source_id fields. Punchh allows external identifiers to be sent with a user profile via one of the following sign-up endpoints:
   • Mobile Signup API
   • SSO Signup API
     
     
2. Existing Punchh users
   Update external_source_id for existing Punchh users. Punchh allows external identifiers to be added to a profile via a user API update endpoint:
   • Mobile User Update
   • SSO User Update
   • Dashboard User Update
     
     

• User sign-up API example
• User update API example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --location --request POST 'https://sandbox.punchh.com/api2/mobile/users' \
--header 'Content-Type: application/json' \
--header 'x-pch-digest: eac5b04cbf7362c5359a4c259cf8fc18941646bf2e11bfe46be0031ffaa1100b' \
--header 'Accept-Timezone: Etc/UTC' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--data-raw '{
    "client":"1533b61caecafea4303aa1f4bad8321d6d8e7a843593e4a0e0024ae0d30b",
    "user" : {
      "email": "[email protected]",
      "password": "[email protected]",
      "first_name":"Amit",
      "last_name":"K",
      "terms_and_conditions":"true",
      "anniversary":"2014-02-02",
      "zip_code":"94497",
      "birthday":"2004-02-02",
      "external_source":"customer_id",
      "external_source_id":"556644557788334412"
      }
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
curl --location --request PUT 'https://sandbox.punchh.com/api2/mobile/users' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'x-pch-digest: 953d896eebfdb5a84aacb9d1b8eaae1fa0cd710b68bcd3b2324415ac40fee99c' \
--header 'Authorization: Bearer c90b819bf962db9882eeac6993b57c0a22816ecad0e5229b27320d63' \
--data-raw '{
    "client":"1533b61caecafea4303aa1f4bad8321d6d8e7a843593e4a0e0024ae0d30b",
    "user": {
        "external_source":"customer_id",
        "external_source_id":"556644557788334412"
    }
}'

Step 2: Braze adapter setup in Punchh

Available events to sync

1. Guest - triggered upon any signup, update to guest profile, deactivated or deleted, etc.
2. Loyalty Check-in - triggered for loyalty transactions or earning by scanning barcode from the receipt
3. Gift Check-in - triggered for points gifted from a campaign
4. Redemption - triggered in case of any reward redemption excluding Punchh coupons, as those would be sent separately as coupon events, including issuance as well as redemption
5. Rewards - triggered from rewards gifted from campaigns, activity, conversion from points to rewards, admin gifting, etc.
6. Transaction Notifications - triggered upon transactional activity for a user within the Punchh system. For example, point expiration.
7. Marketing Notifications - triggered based on different campaign setups in Punchh for an associated segment of users

Work with your Punchh Implementation manager to set up this adapter.

To set up the Braze and Punchh integration:

1. In the Punchh dashboard, navigate to Cockpit > Dashboard > Major Features > Enable Webhook Management and toggle on Enable Webhook Management.
   
   
2. Next, enable adapters by navigating to Settings > Webhooks Manager > Configurations > Show Adapters Tab and toggle on Show Adapters Tab.
   
   
3. Navigate to Webhooks Manager under the Settings tab, select the Adapters tab, and click Create Adapter.
   
   
   
   
4. Fill in the adapter name, description, and admin email. Select Braze as your adapter and provide your Braze REST API endpoint and Braze API key.
   
   
5. Next, select the available events you would like to enable. A list of these events can be found in Available events to sync.
   
   
   
   
6. Click Submit to enable the webhook.

Create Punchh webhook in Braze

Braze can add users to a Punchh segment through webhooks utilizing Punchh Custom Segments.

1. Create a custom segment in Punchh and note the custom_segment_id present in the Punchh segment dashboard URL as shown below. Both classic or beta segment builders can be used. However, beta is recommended as classic will eventually be deprecated.
   
   In the Punchh platform, navigate to Guest > Segment > Custom List > New Custom List.
   
   
   
   

2. Create a webhook campaign in Braze using the Punchh endpoint for adding a user to a custom segment as the webhook URL. Here, you can provide the custom_segment_id pulled from the URL and user_id as key-value pairs.
   
   
   
   

3. This webhook can be set up as a singular campaign or as a step within a canvas. Alternatively, if the webhook adding users to this specific Punchh segment will be used in multiple campaigns or canvases, it can be set up as a template.
   
   The user_id key within the webhook maps to the Punchh user ID. This identifier will need to be added to all webhooks created in Braze to add users to a Punchh custom segment. The punch_user_id custom attribute can be dynamically populated as the value for the user_id key using Liquid. You can insert the punchh_user_id custom attribute variable using the blue “plus” icon located on the top-right of any templated text field.
   
   
   
   
   
   

4. Once the webhook is saved, it can be used to sync users, as shown below. For example, 136 guests would be added to the Punch custom segment when this Braze webhook campaign is launched.
   
   

For more information on how webhooks are used at Braze, check out Creating a webhook.

Use case campaigns

Campaign and Canvas configuration

Triggering

Use cases for Braze messaging triggered by Punchh events being sent to Braze, such as reward events or guest events, can be created as action-based campaigns or Canvases triggered by the relevant Punchh event.

Adding a trigger will pull up the list of events created in Braze. Choose the event that should trigger your campaign or Canvas to be sent to the user who logged the event.

Property filters can be added to further filter the triggering event. For example, the message should only be triggered when a customer triggers the “checkins_gift” event where the approved event property is true. This is an optional feature that may not be applicable to all use cases.

Segmentation

In many cases, Braze campaigns and Canvases being triggered by Punchh events can be set to an “All Users” audience since the segmentation of users triggering these events will be determined within Punchh. However, customers looking to further refine the audience of users who will receive the Braze messaging triggered by the event can do so by adding additional filters and segments in the Target Audiences section of the campaign composer or the Entry Audience of the Canvas composer.

Example use cases

• Signup
• Mass offer
• Recurring mass offer
• Post check-in offer with notification
• Post check-in offer without notification
• Anniversary
• Recall