{
"event": {
"id": "8d2e4b61-5a3f-4c7e-9b10-2f6a7c8d9e01",
"type": "voucher-set-activated",
"timestamp": 1793700902
},
"payload": {
"id": 2030,
"resource": "voucher-set",
"providerPartnerId": 42,
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code",
"status": "active",
"availability": "active",
"liveRevisionId": 22017,
"liveRevisionNo": 2,
"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"
}
],
"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
},
"pendingChangeRequestId": null,
"activeFrom": null,
"deactivateAt": null,
"activatedAt": "2026-11-01T00:00:12Z",
"deactivatedAt": null,
"suspendedAt": null,
"archivedAt": null,
"suspensionReason": null,
"stock": {
"remaining": 9950,
"used": 50,
"usagePercent": 0.5,
"availableVoucherCount": 9950,
"expiredVoucherCount": 0,
"revokedVoucherCount": 0,
"stockStatus": "available",
"updatedAt": "2026-10-22T07:58:31.204Z"
},
"createdBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"createdAt": "2026-10-20T09:12:44.501Z",
"updatedAt": "2026-10-22T07:10:02.300Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"vouchers": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/vouchers",
"type": "application/json"
},
"uploads": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/uploads",
"type": "application/json"
},
"changeRequests": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests",
"type": "application/json"
},
"changelog": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/changelog",
"type": "application/json"
},
"revisions": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions",
"type": "application/json"
},
"stockAlertRule": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/stock-alert-rule",
"type": "application/json"
}
}
}
}voucher-set
voucher-set-activated
A voucher set became active, through activate now or when its scheduled activeFrom was reached.
WEBHOOK
voucher-set-activated
{
"event": {
"id": "8d2e4b61-5a3f-4c7e-9b10-2f6a7c8d9e01",
"type": "voucher-set-activated",
"timestamp": 1793700902
},
"payload": {
"id": 2030,
"resource": "voucher-set",
"providerPartnerId": 42,
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code",
"status": "active",
"availability": "active",
"liveRevisionId": 22017,
"liveRevisionNo": 2,
"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"
}
],
"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
},
"pendingChangeRequestId": null,
"activeFrom": null,
"deactivateAt": null,
"activatedAt": "2026-11-01T00:00:12Z",
"deactivatedAt": null,
"suspendedAt": null,
"archivedAt": null,
"suspensionReason": null,
"stock": {
"remaining": 9950,
"used": 50,
"usagePercent": 0.5,
"availableVoucherCount": 9950,
"expiredVoucherCount": 0,
"revokedVoucherCount": 0,
"stockStatus": "available",
"updatedAt": "2026-10-22T07:58:31.204Z"
},
"createdBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"createdAt": "2026-10-20T09:12:44.501Z",
"updatedAt": "2026-10-22T07:10:02.300Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"vouchers": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/vouchers",
"type": "application/json"
},
"uploads": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/uploads",
"type": "application/json"
},
"changeRequests": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests",
"type": "application/json"
},
"changelog": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/changelog",
"type": "application/json"
},
"revisions": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions",
"type": "application/json"
},
"stockAlertRule": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/stock-alert-rule",
"type": "application/json"
}
}
}
}Audience: provider · Trigger:
voucher-set-activated · Payload: the voucher set in its webhook view, as payload next to event; deduplicate on event.id.Authorizations
Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.
Headers
t=,s1=<hex HMAC-SHA256 of "." with your first secret>,s2=. See Verifying signatures.
Body
application/json
Response
Acknowledge receipt within 15 seconds.