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:

How to Set up RTM

To set up RTM, you'll need to set an endpoint in your app to consume RTM events. Once you have done that, you can coordinate with Cardlytics to begin sending events to that endpoint.

Contact your designated Cardlytics implementation consultant for more information.

Supported RTM Events

Redemption Notification

Example

The following example represents a confirmed redemption event. It describes a webhook payload for a successful redemption processing after a cleared transaction.

{
    "event": "REDEMPTION_CONFIRMED",
    "eventId": "380052b4-3a64-4952-b640-ba696eb9f44b",
    "eventTimestamp": "2023-04-29T11:06:55.000Z",
    "redemptions": [
        {
            "redemptionId": "992745",
            "adId": "123",
            "amount": 5.00,
            "redemptionDate": "2023-03-21T12:58:34Z",
            "sourceCustomerId": "609a180c-c896-4ccb-8ef6-8b24fd6ef32b",
            "sourceAccountId": "388836454",
            "redeemingTransactionAmount": 34.46,
            "transactionId": "929994552",
            "rewardSettlementRunDate": "2023-03-23T10:44:23Z"
        }
    ]
}

Redemption Notification -- Pending

Example

The example shows the payload for a realtime message after an eligible authenticated transaction.

{
   "event":"REDEMPTION_PENDING",
   "eventId":"0e486fb7-176b-45bc-9263-aadbc332400f",
   "eventTimestamp":"2024-09-10T08:26:01.693504371Z",
   "redemptions":[
      {
         "redemptionId":"0e486fb7-176b-45bc-9263-aadbc332400f",
         "adId":"1000061994",
         "amount":"207",
         "date":"2024-09-10T08:26:01.693504371Z",
         "sourceCustomerId":"AZFFL6QfbPoBxYMghFLkZodo7VQSLx29ah8dzv9gQKjHMMwPNhHzjNhbh5FSTy7MZdiMb1ZwKYMfaNDJh43zwiN7tdG",
         "sourceAccountId":"riiDHpQmwLxp3Xc1sytdJsmmBQkVxsaZn8yLkmjd2eofVGSJfbQvSqL52yX1rwRgErNPdFvCF4NFZUvw8AMHyD2kfSGYrYMs5iAbtFUirPav16gkBLSq",
         "redeemingTransactionAmount":"4136",
         "transactionId":"5x6KV26iSctZyuMCXUKNYmTi7Y4g3X7sy1TRkiUiG1Q5hxrDh57QFhzzLLwPJoG6zQwrgau87Wa24wtzcNvr8bNtSJFt2rHH1vZoMtf",
         "rewardSettlementRunDate":null
      }
   ]
}