{
"event": {
"id": "3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17",
"type": "catalog-voucher-set-activated",
"timestamp": 1793610900
},
"payload": {
"id": 2030,
"resource": "consumer-catalog-entry",
"providerPartnerId": 1030,
"provider": {
"id": 1030,
"resource": "consumer-catalog-provider",
"slug": "acme-scooters",
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"logoUrl": "https://assets.voucher.allride.io/acme-scooters/3095.png",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
"type": "application/json"
}
}
},
"voucherKind": "code",
"availability": "active",
"activeFrom": "2026-10-01T00:00:00Z",
"deactivateAt": null,
"revisionNo": 2,
"revisionApprovedAt": "2026-09-28T09:40:11Z",
"live": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "€5.00"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"brandingOverrideAssetUrls": null,
"stockStatus": "available",
"providerToggle": true,
"voucherSetToggle": true,
"position": 1,
"featured": true,
"effectiveCategoryId": 7017,
"priceAcceptance": {
"status": "accepted",
"nextChangeAt": null
},
"setting": {
"enabled": true,
"position": null,
"featured": false,
"categoryOverrideId": null,
"entityLimit": {
"max": 1,
"period": "calendar-month"
},
"settings": null,
"externalRef": "3",
"updatedAt": "2026-10-20T10:02:00Z"
},
"_links": {
"self": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
"type": "application/json"
},
"provider": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
"type": "application/json"
}
}
}
}Catalog
catalog-voucher-set-activated
A voucher set became active
WEBHOOK
catalog-voucher-set-activated
{
"event": {
"id": "3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17",
"type": "catalog-voucher-set-activated",
"timestamp": 1793610900
},
"payload": {
"id": 2030,
"resource": "consumer-catalog-entry",
"providerPartnerId": 1030,
"provider": {
"id": 1030,
"resource": "consumer-catalog-provider",
"slug": "acme-scooters",
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"logoUrl": "https://assets.voucher.allride.io/acme-scooters/3095.png",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
"type": "application/json"
}
}
},
"voucherKind": "code",
"availability": "active",
"activeFrom": "2026-10-01T00:00:00Z",
"deactivateAt": null,
"revisionNo": 2,
"revisionApprovedAt": "2026-09-28T09:40:11Z",
"live": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "€5.00"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"brandingOverrideAssetUrls": null,
"stockStatus": "available",
"providerToggle": true,
"voucherSetToggle": true,
"position": 1,
"featured": true,
"effectiveCategoryId": 7017,
"priceAcceptance": {
"status": "accepted",
"nextChangeAt": null
},
"setting": {
"enabled": true,
"position": null,
"featured": false,
"categoryOverrideId": null,
"entityLimit": {
"max": 1,
"period": "calendar-month"
},
"settings": null,
"externalRef": "3",
"updatedAt": "2026-10-20T10:02:00Z"
},
"_links": {
"self": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
"type": "application/json"
},
"provider": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
"type": "application/json"
}
}
}
}Audience: consumer · Trigger: The set becomes active · Payload:
ConsumerCatalogEntry
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
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Headers
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
Response
Acknowledge receipt within 15 seconds.