Reward Issued

{
  "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"
      }
    }
  }
}

{
  "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"
      }
    }
  }
}

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

string

The event type: reward.issued

string

The time the event occurred (ISO8601)

hash

Event data

Show data

string

The ID of the issuance job that triggered this reward

string

The ID of the merchant associated with the issuance job

string

The ID of the issued reward

hash

The identifier used to issue the reward

Show identifier

string

Identifier type: email or phone

integer

Position in the original identifiers array

string

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

string

The state of the reward. The value is available, active, used, or pending. The value is never null or an empty string ("").

string

The date the reward stops being redeemable (ISO8601), or null when the campaign sets neither a redemption end date nor a relative window.When both are set, this is whichever comes first: the campaign’s redeemable_to, or retire_after_days counted from the moment the reward was issued. It is the same date the guest sees and the one redemption enforces.

hash

Campaign information

Show campaign

string

Campaign ID

string

Campaign name

string

Campaign objective

string

Campaign start date (ISO8601)

string

Campaign end date (ISO8601)

string

Reward redemption start date (ISO8601)

string

Reward redemption end date (ISO8601)

string

Campaign time zone

string

Terms and conditions

hash

The variant used for issuance

Show variant

string

Variant ID

string

Variant name

string

Reward template ID

On an evergreen campaign — retire_after_days set and no redeemable_to — expires_at is the only field in this payload carrying the reward’s expiry date. campaign.redeemable_to is null by design.

{
  "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