How It Works

Webhooks enable you to communicate with your customers based on platform activity or transactional behavior. Explore the examples below and the diagram, followed by the section on how to build webhooks.

Examples

• Redemption close-the-loop notifications. Using this webhook, you can communicate at the time of swipe that your customer's purchase has qualified for a reward, and that their redemption is in progress. For a description of Redemption properties and types, see the API Reference Redemption list.

• Activity-based communication. This webhook works as follows:

As a Publisher, you pass authentication data to Cardlytics through the Transaction API.

Next, Cardlytics processes the authentication data to match the offer:

• Match to the right merchant
• Match to one or more valid offers
• Determine qualifying events

Cardlytics then shares the qualifying event through the Publisher-managed Webhook, as described in the section below.

In the end, the Publisher initiates customer messaging, congratulating them on the earned reward.

At a Glance

Activity-based communication is illustrated in the diagram below:

Building Webhooks

To start, you should include the fields shown below in the Webhook that you build.

Once the authorization data has been ingested and the necessary matching logic and verification steps performed, Cardlytics will return valid notifications to the your Webhook API described below.

Caveats: You should pay special attention to the SourceAccountId. The SourceAccountID provided by Cardlytics corresponds to the ID received from you during transaction imports. This is not necessarily the same as the AccountIDs used throughout other Publisher systems.