Receive webhooks

2min
API publishers can receive webhook requests when certain Events﻿ occur. A typical webhook request uses the following format. All fields are required. The data field contains the actual payload, while the other fields provide supplementary information to help with identification and security.
All time values are in the Coordinated Universal Time (UTC) time zone.
Payload format
Below is a general example of a payload format for receiving webhooks.
JS
{
    "publisher_uid": "P1035",
    "publisher_user_id": "p-123",
    "event_type": "transaction.created",
    "data":
    {
        "transaction_uid": "20fdb195-9fbf-4d05-b0b3-ba74c8f8b76e",
        "transaction_date_time": "2024-07-23T00:00:00",
        "reward_type": "CASHBACK_PERCENTAGE",
        "offer_type": "GIFT_CARD",
        "user_cashback": 0.72,
        "transaction_amount": 12,
        "currency_code": "USD",
        "status": "PENDING",
        "brand_uid": "A14232",
        "offer_uid": "O14280",
        "publisher_share": 0.84
    },
    "event_timestamp": "2024-08-05T09:09:54"
}

{
    "publisher_uid": "P1035",
    "publisher_user_id": "p-123",
    "event_type": "transaction.created",
    "data":
    {
        "transaction_uid": "20fdb195-9fbf-4d05-b0b3-ba74c8f8b76e",
        "transaction_date_time": "2024-07-23T00:00:00",
        "reward_type": "CASHBACK_PERCENTAGE",
        "offer_type": "GIFT_CARD",
        "user_cashback": 0.72,
        "transaction_amount": 12,
        "currency_code": "USD",
        "status": "PENDING",
        "brand_uid": "A14232",
        "offer_uid": "O14280",
        "publisher_share": 0.84
    },
    "event_timestamp": "2024-08-05T09:09:54"
}
﻿
﻿
Get started using webhooks
Handle Webhook Events