Reward event notification

Authorizations

Authorization

string

header

required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

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

data.reward_id

string

Unique identifier for the reward. Use this reward_id in the Retrieve a reward API to details about the reward

Example:

"DCBFC736-2286-42DD-897D-160DCA80AED2"

data.customer_id

string

Unique identifier for the associated customer

Example:

"2EE24580-B97B-4949-A65C-929CCB9B9B8D"

data.transaction_id

string

Identifies the transaction related to this reward for TRANSACTIONAL typed reward

Example:

"34E24580-B97B-4949-A65C-929CCB9B9B8D"

data.type

enum<string>

Available options:

OFFER,

TRANSACTIONAL,

ONE_TIME,

STATEMENT,

REFERRAL

Example:

"TRANSACTIONAL"

data.amount

integer

Amount of the reward in the smallest currency unit (e.g., cents for USD).

Example:

5000

data.status

enum<string>

Available options:

PENDING,

AVAILABLE,

PENDING_DEDUCTION,

DEDUCTED

Example:

"PENDING"

data.currency

string

The 3-character currency code of the amount in ISO 4217 format (e.g., "USD") or a reward unit (e.g., "POINTS")

Example:

"POINTS"

data.created_at

string

the RFC-3339 timestamp when the reward was created

Example:

"2025-02-13T19:08:07.000Z"

data.metadata

object

Response

200 - text/plain

Webhook received successfully.

The response is of type string.

Basics

API Reference

Reward event notification

Authorizations

Headers

Body

Response