Reward Batch Completed

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

event

string

The event type: reward_batch.completed

timestamp

string

The time the event occurred (ISO8601)

data

hash

Event data

Show data

issuance_job_id

string

The ID of the completed issuance job

merchant_id

string

The ID of the merchant associated with the issuance job

state

string

Final job state: completed or failed

total_count

integer

Total number of identifiers in the batch

issued_count

integer

Number of rewards successfully issued

failed_count

integer

Number of failed issuances

failures

array

Details of any failed issuances

Show failure

user_identifier

string

The identifier value (email or phone) that failed

reason

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

Webhooks

Reference

Reward Batch Completed

Event

Payload Description

​Event

​Payload Description

Event

Payload Description