Webhook events

Redemption pending

A redemption was authorized and its funds are reserved for later fulfillment. Scrip sends this request to every endpoint subscribed to redemption.pending, signed with both the Standard Webhooks headers (webhook-id, webhook-timestamp, webhook-signature) and the Scrip-Signature header; verify either one.

postWebhookredemption.pending

Payload

api_versionstring required

The payload contract that data follows. Scrip adds fields without changing it, so ignore fields you do not know.

created_atstring date-time required

When Scrip created the event, as an RFC 3339 timestamp.

idstring uuid required

The id of the webhook event. It is the same for every endpoint that receives the event.

organization_idstring uuid required

The organization that owns the event.

testboolean

True on a delivery from a test send. It is absent on a real delivery.

type'redemption.pending' required

The event type.

Example payload

{
  "api_version": "2026-10-07",
  "created_at": "2027-01-15T10:30:00Z",
  "data": {
    "amount": "50.0",
    "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
    "expires_at": "2027-12-31T23:59:59Z",
    "organization_id": "b6c2e8f4-9a1d-4d37-8e52-7c0a9f3b1d20",
    "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
    "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
    "quantity": 2,
    "redemption_id": "7f422b43-4ba2-41c7-b05d-e4e90b68e978",
    "reservation_id": "5d1f8a26-3c79-4e0b-9a64-b2e7c1d85f10",
    "reward_id": "2b7a9c4e-1f3d-4a8b-9e6c-5a1d3f7b8c08",
    "status": "PENDING"
  },
  "id": "0e7c2f3a-4f6e-4a39-9a0b-6f1d3c8b2e11",
  "organization_id": "b6c2e8f4-9a1d-4d37-8e52-7c0a9f3b1d20",
  "test": true,
  "type": "redemption.pending"
}

Response

Return any 2xx status to acknowledge the delivery. Scrip retries any other status except 410 Gone, which ends the delivery as FAILED.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.