redemption-created

A redemption was made

WEBHOOK redemption-created

default

{
  "event": {
    "id": "3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17",
    "type": "redemption-created",
    "timestamp": 1793610900
  },
  "payload": {
    "id": 6017,
    "resource": "redemption",
    "status": "completed",
    "channel": "api",
    "providerPartnerId": 1030,
    "voucherSetId": 2030,
    "voucherSetRevisionNo": 2,
    "voucherId": 5017,
    "voucherSet": {
      "id": 2030,
      "name": {
        "de": "5 € Fahrguthaben",
        "en": "€5 ride credit"
      },
      "providerDisplayName": {
        "de": "Acme Scooters",
        "en": "Acme Scooters"
      }
    },
    "issued": {
      "kind": "code",
      "code": "ACME5-7KQ2-M9XA",
      "link": "https://acme-scooters.example.com/r?c=ACME5-7KQ2-M9XA"
    },
    "validFrom": null,
    "validUntil": "2026-12-31T22:59:59Z",
    "redemptionEntity": {
      "id": 9017,
      "resource": "redemption-entity",
      "refId": "customer:48213",
      "_links": {
        "self": {
          "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
          "type": "application/json"
        }
      }
    },
    "redemptionLink": null,
    "batchId": null,
    "metadata": {
      "redemptionReason": "standard",
      "forMonth": "2026-10"
    },
    "actor": {
      "type": "api-key",
      "id": 12017,
      "label": "Production integration"
    },
    "idempotencyKey": "order-8812:line-1",
    "legacyRef": null,
    "redeemedAt": "2026-10-21T17:42:10.120Z",
    "voidedAt": null,
    "voidedBy": null,
    "voidReason": null,
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/redemptions/6017",
        "type": "application/json"
      },
      "voucherSet": {
        "href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
        "type": "application/json"
      },
      "redemptionEntity": {
        "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9017",
        "type": "application/json"
      }
    }
  }
}

Audience: consumer · Trigger: A voucher is redeemed (any channel except import) · Payload: Redemption

Verify the x-signing-signature header before you trust the body (Verifying signatures). Deliveries are at least once and unordered; deduplicate on event.id.

Authorizations

Authorization · string · header · required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

x-signing-signature · string · required

t=<unix seconds>,s1=<hex HMAC-SHA256 of "<raw body>.<t>" with your first secret>,s2=<the same with your second secret>. Accept the delivery when either signature matches. See Verifying signatures.

Body

application/json

Body of a redemption-created webhook.

event · object · required

The event.

Show child attributes

payload · object · required

The resource the event is about, starting with resource and id: the consumer view of the resource, or the fields this event type defines.

Show child attributes

Response

2XX

Acknowledge receipt within 15 seconds.