Skip to main content
WEBHOOK

Body

application/json

Body Rigaly POSTs to your digital_webhook_url. IDs only — no customer PII.

event
enum<string>
Available options:
reward.provision
Example:

"reward.provision"

test
boolean

true for calls from POST /rewards/{id}/webhook/test. Return a throwaway value for these.

Example:

false

idempotency_key
string

Also sent as the Idempotency-Key header. The same key must always return the same value — never mint a new one on a retry.

Example:

"9f1c3a2e-5b7d-4e21-9a0c-1f2d3e4b5a67"

redemption_id
string<uuid> | null

null on test calls.

reward_id
string<uuid>
business_id
string<uuid>
user_id
string<uuid> | null

The Rigaly customer. null on test calls.

asset_type
enum<string>

The reward's digital_asset_type — your response's type must match it exactly.

Available options:
code,
link
requested_at
string<date-time>

Response

The minted value. Any 2xx status is accepted.

What your endpoint must return with a 2xx status, within 5 seconds and under 64 KB.

type
enum<string>
required

Must equal the reward's digital_asset_type; a mismatch is rejected and the redemption cancelled.

Available options:
code,
link
Example:

"code"

value
string
required

The code, or an http(s) URL when type is link.

Required string length: 1 - 500
Example:

"NETFLIX-XYZ123"

expires_at
string<date-time> | null

Optional. Must be in the future if present.

Example:

"2026-12-31T23:59:59Z"