Reward Batch Completed

{
  "event": "reward_batch.completed",
  "timestamp": "2025-06-15T10:30:15Z",
  "data": {
    "issuance_job_id": "job_xyz789",
    "merchant_id": "mer_abc123",
    "state": "completed",
    "total_count": 2,
    "issued_count": 1,
    "failed_count": 1,
    "failures": [
      {
        "user_identifier": "+14155551234",
        "reason": "User not found"
      }
    ]
  }
}

This webhook is sent once when an entire issuance job finishes processing. It provides a summary of the batch including total counts and any failures. This fires regardless of whether all rewards succeeded or some failed.

Event

reward_batch.completed

Payload Description

string

The event type: reward_batch.completed

string

The time the event occurred (ISO8601)

hash

Event data

Show data

string

The ID of the completed issuance job

string

The ID of the merchant associated with the issuance job

string

Final job state: completed or failed

integer

Total number of identifiers in the batch

integer

Number of rewards successfully issued

integer

Number of failed issuances

array

Details of any failed issuances

Show failure

string

The identifier value (email or phone) that failed

string

Error message describing the failure

{
  "event": "reward_batch.completed",
  "timestamp": "2025-06-15T10:30:15Z",
  "data": {
    "issuance_job_id": "job_xyz789",
    "merchant_id": "mer_abc123",
    "state": "completed",
    "total_count": 2,
    "issued_count": 1,
    "failed_count": 1,
    "failures": [
      {
        "user_identifier": "+14155551234",
        "reason": "User not found"
      }
    ]
  }
}

⌘I

Webhooks

Reference

Reward Batch Completed

Event

Payload Description

​Event

​Payload Description

Event

Payload Description