WebhooksEvent catalogShop
shop.listing.retired
Version 1 of the shop.listing.retired webhook event.
A Shop listing left the published catalog for its terminal retired state. A retired listing can no longer be bought and is not newly referenceable; orders already settled against it are unaffected and still read.
| Event type | shop.listing.retired |
| Schema version | 1 |
| Routing key | event.shop.listing.retired.v1 |
| Produced by | Reward Management |
| Schema | urn:defendr:contract:shop:listing-retired:1 |
data fields
| Field | Type | Required | Description |
|---|---|---|---|
listingKey | string | yes | |
revision | integer | yes | |
actorId | string | yes | |
reason | string or null | yes | The operator's retirement reason, if one was recorded. |
retiredAt | string (date-time) | yes |
Some fields are required only in particular states. The JSON Schema below is authoritative.
Example delivery
Signed with the example secret whsec_placeholder_example_webhooks_signing_secret, so you can check your verifier against it. See Verifying signatures.
POST /your/webhook/endpoint HTTP/1.1
content-type: application/json
webhook-id: whd_00000000-0000-4000-8000-000000000028
webhook-timestamp: 1800000000
webhook-signature: v1,BL5NGsu6IOufsY6KCeD9Tz62ljfpXOALrS29gFTKcxQ=
tanitar-event-type: shop.listing.retired
tanitar-schema-version: 1
tanitar-delivery-attempt: 1
{"messageId":"evt_00000000-0000-4000-8000-000000000028","kind":"event","type":"shop.listing.retired","schemaVersion":1,"occurredAt":"2027-01-15T10:00:00.000Z","producer":"reward-management-service","accountId":"acc_11111111-1111-4111-8111-111111111111","correlationId":"corr_00000000-0000-4000-8000-000000000028","data":{"listingKey":"founder-badge","revision":4,"actorId":"operator_demo","reason":"Seasonal cosmetic withdrawn at the end of the campaign.","retiredAt":"2026-09-27T00:00:00.000Z"}}The same body, formatted:
{
"messageId": "evt_00000000-0000-4000-8000-000000000028",
"kind": "event",
"type": "shop.listing.retired",
"schemaVersion": 1,
"occurredAt": "2027-01-15T10:00:00.000Z",
"producer": "reward-management-service",
"accountId": "acc_11111111-1111-4111-8111-111111111111",
"correlationId": "corr_00000000-0000-4000-8000-000000000028",
"data": {
"listingKey": "founder-badge",
"revision": 4,
"actorId": "operator_demo",
"reason": "Seasonal cosmetic withdrawn at the end of the campaign.",
"retiredAt": "2026-09-27T00:00:00.000Z"
}
}JSON Schema
urn:defendr:contract:shop:listing-retired:1
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:defendr:contract:shop:listing-retired:1",
"title": "Shop listing retired",
"description": "A Shop listing left the published catalog for its terminal `retired` state. A retired listing can no longer be bought and is not newly referenceable; orders already settled against it are unaffected and still read.",
"type": "object",
"additionalProperties": false,
"required": [
"listingKey",
"revision",
"actorId",
"reason",
"retiredAt"
],
"properties": {
"listingKey": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"revision": {
"type": "integer",
"minimum": 1
},
"actorId": {
"type": "string",
"minLength": 1
},
"reason": {
"type": [
"string",
"null"
],
"description": "The operator's retirement reason, if one was recorded."
},
"retiredAt": {
"type": "string",
"format": "date-time"
}
}
}