Reward Issued

This webhook is sent each time an individual reward is successfully issued to a user during a partner issuance job. If a batch contains 100 identifiers, up to 100 individual reward.issued webhooks may be sent (one per successful issuance).

Event

reward.issued

Payload Description

event

string

The event type: reward.issued

timestamp

string

The time the event occurred (ISO8601)

data

hash

Event data

Show data

issuance_job_id

string

The ID of the issuance job that triggered this reward

merchant_id

string

The ID of the merchant associated with the issuance job

reward_id

string

The ID of the issued reward

identifier

hash

The identifier used to issue the reward

Show identifier

type

string

Identifier type: email or phone

index

integer

Position in the original identifiers array

user_id

string

The ID of the user who received the reward, if found

state

string

The reward state (e.g., active, pending, delivered)

expires_at

string

The reward expiration date (ISO8601), if applicable

campaign

hash

Campaign information

Show campaign

string

Campaign ID

name

string

Campaign name

objective

string

Campaign objective

start_at

string

Campaign start date (ISO8601)

end_at

string

Campaign end date (ISO8601)

redeemable_from

string

Reward redemption start date (ISO8601)

redeemable_to

string

Reward redemption end date (ISO8601)

time_zone

string

Campaign time zone

fine_print

string

Terms and conditions

variant

hash

The variant used for issuance

Show variant

string

Variant ID

name

string

Variant name

reward_template_id

string

Reward template ID

{
  "event": "reward.issued",
  "timestamp": "2025-06-15T10:30:10Z",
  "data": {
    "issuance_job_id": "job_xyz789",
    "merchant_id": "mer_abc123",
    "reward_id": "rwd_abc123",
    "identifier": {
      "type": "email",
      "index": 0
    },
    "user_id": "usr_def456",
    "state": "active",
    "expires_at": "2025-09-30T23:59:59Z",
    "campaign": {
      "id": "camp_abc123",
      "name": "Summer Free Coffee",
      "objective": "Re-engage lapsed customers",
      "start_at": "2025-06-01T00:00:00Z",
      "end_at": "2025-08-31T23:59:59Z",
      "redeemable_from": "2025-06-01T00:00:00Z",
      "redeemable_to": "2025-09-30T23:59:59Z",
      "time_zone": "America/Los_Angeles",
      "fine_print": "Limit one per customer",
      "variant": {
        "id": "var_treat1",
        "name": "Treatment",
        "reward_template_id": "abc123def456"
      }
    }
  }
}

Webhooks

Reference

Reward Issued

Event

Payload Description

​Event

​Payload Description

Event

Payload Description