Reward event notification

{
  "object": "REWARD",
  "data": {
    "merchant_key": "MERCHANT_ABC",
    "reward_id": "DCBFC736-2286-42DD-897D-160DCA80AED2",
    "customer_id": "2EE24580-B97B-4949-A65C-929CCB9B9B8D",
    "transaction_id": "34E24580-B97B-4949-A65C-929CCB9B9B8D",
    "type": "TRANSACTION",
    "amount": 5000,
    "status": "PENDING",
    "currency": "POINTS",
    "created_at": "2025-02-13T19:08:07.000Z",
    "metadata": {
      "offer_id": "2bd247a1-d935-4b26-88c3-7b3a55ac910b"
    },
    "customer_metadata": {
      "loyalty_id": "840012345678",
      "membership_tier": "gold"
    }
  }
}

<string>

WEBHOOK

Reward

{
  "object": "REWARD",
  "data": {
    "merchant_key": "MERCHANT_ABC",
    "reward_id": "DCBFC736-2286-42DD-897D-160DCA80AED2",
    "customer_id": "2EE24580-B97B-4949-A65C-929CCB9B9B8D",
    "transaction_id": "34E24580-B97B-4949-A65C-929CCB9B9B8D",
    "type": "TRANSACTION",
    "amount": 5000,
    "status": "PENDING",
    "currency": "POINTS",
    "created_at": "2025-02-13T19:08:07.000Z",
    "metadata": {
      "offer_id": "2bd247a1-d935-4b26-88c3-7b3a55ac910b"
    },
    "customer_metadata": {
      "loyalty_id": "840012345678",
      "membership_tier": "gold"
    }
  }
}

<string>

Headers

X-IMPRINT-HMAC-SIGNATURE

string

required

HMAC signature generated using shared webhook secret and webhook payload

Body

application/json

object

enum<string>

The type of object associated with this webhook event. This field indicates what kind of resource has been created or updated.

Available options:

REWARD

Example:

"REWARD"

data

object

Show child attributes

Response

200 - text/plain

Webhook received successfully.

The response is of type string.