Event reference

All Seller API webhook events with triggers and payload shapes.

Every webhook event the Seller API can deliver: 79 event types, one section each, the same list GET /webhooks/event-types returns. Subscribe only to events you handle. Delivery is at-least-once: dedupe on eventLogId / X-Avrix-Event-Log-Id, which is the same for one event on every endpoint, retry and replay. Every event is also recorded in your event log, which GET /events serves on contract date 2026-12-01 and later whether or not an endpoint subscribes.

Example#

# Verification is server-side in your webhook handler — not a curl call.
# Header: X-Avrix-Signature: t=<unix>,v1=<hex>[,v1=<hex>] (two v1 during a secret rotation; accept either)
# Signed payload: "{t}.{rawBody}" with HMAC-SHA256 and your endpoint secret.

Every delivery is one flat JSON object. Five envelope fields are present. Avrix sets eventId, eventLogId, eventType and eventVersion, and event data can never override them; occurredAt is the event's own time when it has one. Every other top-level field belongs to the event:

JSON
{
  "eventId": "evt_1754385262108_9f2c4b1e7a3d5c60",
  "eventLogId": "evt_1754385262101_3b7e0c9a5d1f2e84",
  "eventType": "order.fulfilled",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "pulled": 1
}
  • eventId is the same value as the X-Avrix-Event-Id header. It is minted per delivery: the same event sent to two of your endpoints carries a different id on each, and a replay carries a new one.
  • eventLogId is the same value as the X-Avrix-Event-Log-Id header. It is the event's own id: one value per event, the same on every endpoint, retry and replay, and the id of the event in GET /events. Dedupe on it. Test deliveries (POST /webhooks/{id}/test) are not events and carry none; neither do deliveries created before the event log existed, nor, in rare cases, an event that could not be recorded. Fall back to replay?.originalEventId ?? eventId when it is absent.
  • The X-Avrix-Delivery-Id header names the delivery row, as GET /webhooks/{id}/deliveries lists it; use it when you report a delivery problem.
  • eventType is the same value as X-Avrix-Event-Type; switch on it.
  • eventVersion is a string ("1" today), the same value as X-Avrix-Event-Version.
  • occurredAt is on every delivery: the time the event happened where the event records one, otherwise the time the delivery was created.
  • There is no data wrapper and no envelope-level createdAt. Other timestamps are event-specific (updatedAt, emittedAt, sentAt, readyAt, …).
  • A delivery created by POST /webhooks/{id}/deliveries/replay carries a fresh eventId, the original eventLogId, and a top-level replay object, { "sourceDeliveryId": "…", "originalEventId": "…" }. See Webhooks.

Every example below is a full delivery body: the envelope first, then the event's own fields. Fields are typed per event in the OpenAPI webhooks section.

Event log#

Every event Avrix raises for your company is recorded once in your event log, whether or not one of your endpoints subscribes to it, and kept 30 days. On contract date 2026-12-01 and later GET /api/seller/v1/events serves it, oldest first:

JSON
{
  "data": [
    {
      "id": "evt_1764583200101_5c2e9a7b1d3f4e60",
      "eventLogId": "evt_1764583200101_5c2e9a7b1d3f4e60",
      "eventType": "return.decided",
      "eventVersion": "1",
      "occurredAt": "2026-12-01T10:00:00.101Z",
      "createdAt": "2026-12-01T10:00:00.164Z",
      "resourceType": "return_request",
      "resourceId": "5d0f8a3e-2b71-4c96-a8e4-3f1b9c7d2e05",
      "payload": {
        "returnRequestId": "5d0f8a3e-2b71-4c96-a8e4-3f1b9c7d2e05",
        "decision": "approved",
        "resolution": "refund",
        "publisherCompanyId": "content-owner-co",
        "keyCount": 2,
        "decisionNote": null,
        "decidedAt": "2026-12-01T10:00:00.101Z"
      }
    }
  ],
  "meta": {
    "requestId": "req_7f3a2c1e",
    "limit": 50,
    "hasMore": false,
    "nextCursor": null,
    "nextUrl": null,
    "nextSince": null,
    "headCursor": "djE6MjAyNi0xMi0wMVQxMDowMDowMC4xNjRa",
    "retentionDays": 30,
    "retainedFrom": "2026-11-01T10:00:05.000Z",
    "positionBeforeRetention": false
  }
}
  • id and eventLogId are the id every webhook delivery of the event carries, so a store that takes both webhooks and the feed dedupes on one value.
  • payload is the event's own fields, exactly as the webhook delivery carries them.
  • Filter with eventType (comma-separated, or the parameter repeated; at most 20 names from GET /webhooks/event-types), resourceType and resourceId. An unknown event name is refused with 422 VALIDATION_FAILED.
  • Store meta.headCursor after every page and send it back as cursor on your next poll. The feed reads a few seconds behind the present, so an event recorded a moment before another is never passed over.
  • meta.retainedFrom is the oldest instant the log still holds. When your cursor or since is older, meta.positionBeforeRetention is true: events between your position and retainedFrom may have been deleted. Reconcile from the resources (orders, allocations, catalog), then carry on from headCursor.
  • order.cancelled is recorded once; endpoints subscribed to its older name order.returned receive the same event under that name, with the same eventLogId.
  • On earlier contract dates GET /events keeps returning webhook delivery rows, one per delivery to each of your endpoints. The filters are not read there: they are refused with 422 VALIDATION_FAILED naming them, so a filter is never silently dropped.

What each event is about, for resourceType and resourceId:

resourceTypeEventsresourceId is
orderorder.*, redemption.*, refund.completed, fulfillment.revoked, key.replaced, key.replacement_rejected, keys.revokedorderReference
chargebackchargeback.opened, chargeback.resolvedchargebackReference
catalog_exportcatalog.export_readyexportId
allocationallocation.updated, allocation.depleted, allocation.low_stock, allocation.running_low, allocation.replenished, keys.pulledallocationId
allocation_requestallocation.request_decided, allocation.request_cancelledrequestId
dispute_freezekey.frozen, key.unfrozenfreezeId
productproduct.*, release.*productId
skusku.*skuId
contract_termcontract.*termId
connectionconnection.* except connection.request_decidedconnectionId
connection_requestconnection.request_decidedrequestId
access_proposalaccess.proposal_createdproposalId
return_requestreturn.*returnRequestId
promotionpromotion.*sourceId (a share id when sourceType is event, a deal response id when it is custom)
invoiceinvoice.*, payout.file_readyinvoiceId
reportreport.readyreportId
api_keyapi_key.*, sandbox.certification_passedkeyId
webhook_endpointsystem.webhook_endpoint_disabledendpointId
platform_noticeplatform.noticenoticeId

test.ping names no resource. An event whose payload lacks the id has resourceId: null.


test.ping#

TriggerYou called POST /api/seller/v1/webhooks/{id}/test
Seller actionVerify signature, reject a corrupted signature, acknowledge 2xx
DuplicationSafe to ignore duplicates; use for connectivity only
RelatedWebhook endpoint configuration
JSON
{
  "eventId": "evt_1754385262108_d8231fc3abf55311",
  "eventType": "test.ping",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "test": true,
  "sentAt": "2026-08-05T09:14:22.108Z",
  "endpointId": "b7f1c2d4-5e6a-4b8c-9d0e-1f2a3b4c5d6e"
}

order.fulfilled#

TriggerOrder committed; entitlements issued
Seller actionCorrelate on orderReference; confirm your vault already has entitlements from the HTTP response
DuplicationCommon on retries; dedupe by eventId. May arrive before the HTTP response
RelatedPOST /api/seller/v1/orders, GET /api/seller/v1/orders?orderReference=
JSON
{
  "eventId": "evt_1754385262108_9f2c4b1e7a3d5c60",
  "eventLogId": "evt_1754385262101_4fdbabddd0ce20c2",
  "eventType": "order.fulfilled",
  "eventVersion": "1",
  "occurredAt": "2026-09-22T14:31:07.412Z",
  "orderReference": "store-order-10432",
  "orderId": "ord_6rfz4y3b",
  "orderReadableId": "ord_6rfz4y3b",
  "skuId": "8b9d1c2e-3f40-4a5b-9c6d-7e8f90a1b2c3",
  "skuCode": "WITCHER3-WIN-EU",
  "quantity": 1,
  "fulfilledAt": "2026-09-22T14:31:07.198Z",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "pulled": 1,
  "keyIds": ["8f21a9b0-1234-5678-9abc-def012345678"]
}

The body names what was sold (skuId, skuCode, quantity, fulfilledAt), so a store that queues bodies and processes them later does not need GET /orders/{orderId} per event. Webhook payloads never include key plaintext.


order.failed#

TriggerFulfilment failed after commit was attempted (async failure path)
Seller actionMark the store order failed; refund the buyer at your PSP if you already charged
DuplicationDedupe by eventId; reconcile with GET /orders
RelatedOrder lifecycle, your PSP refunds
JSON
{
  "eventId": "evt_1754385262108_e19ef9ae4e7b1a18",
  "eventLogId": "evt_1754385262101_c68b8607ed6b156d",
  "eventType": "order.failed",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "reason": "preorder_fulfillment_decrypt_failed"
}

order.activated#

TriggerA keyless order was activated for the first time: the buyer revealed the code on the hosted redemption page, or the platform activation completed
Seller actionMark the entitlement as claimed in your order record; a redeemed link can no longer be revoked
DuplicationDedupe by eventId
RelatedKeyless fulfilment, redemption.expiring, redemption.expired
JSON
{
  "eventId": "evt_1754385262108_e9bf0011edaefe54",
  "eventLogId": "evt_1754385262101_2bbc9cbea66bb2f2",
  "eventType": "order.activated",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "fulfillmentId": "5d2c8e1a-7f34-4b69-a0c1-3e9d8b7a6f52",
  "provider": "hosted_redemption",
  "method": "buyer_reveal",
  "platformCode": "windows"
}

method is buyer_reveal or platform_activation. The payload never carries the code itself.


order.reserved#

TriggerPreorder or hot-drop reservation accepted; keys not yet delivered
Seller actionShow “reserved / shipping later” to the buyer. For an order placed with POST /orders, wait for order.ready, then call POST /orders/{orderId}/fulfill; for a key-locked pre-order (bulk line), wait for order.preorder_fulfilled. See pre-orders
DuplicationDedupe by eventId
RelatedPOST /orders, POST /orders/reserve
JSON
{
  "eventId": "evt_1754385262108_13ec999d0d358b26",
  "eventLogId": "evt_1754385262101_7a69f2c299a81f00",
  "eventType": "order.reserved",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "orderId": "ord_01J8XYZ...",
  "reserved": 1,
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "status": "awaiting_release"
}

order.ready#

TriggerA backorder now has inventory for its full quantity, or a deferred pre-order has inventory for its full quantity and its release is deliverable (unlocked, or the pre-order window closed and the release date passed); the order moved to ready. Never sent for a key-locked pre-order (preordered), which Avrix delivers at the release
Seller actionCall POST /api/seller/v1/orders/{orderId}/fulfill with the orderId from the payload, then deliver the keys from that response
DuplicationDedupe by eventId; GET /orders/{orderId} reads status: ready until you fulfil
RelatedOrder lifecycle, order.backorder_expired, backorderOnUnavailable on POST /orders
JSON
{
  "eventId": "evt_1754385262108_37fd23862d553025",
  "eventLogId": "evt_1754385262101_ea5c6dd6a3b21614",
  "eventType": "order.ready",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10433",
  "orderId": "ord_3kq9x2m4v8"
}

No keys are delivered by this event: nothing is revealed until you call fulfil.


order.preorder_fulfilled#

TriggerA key-locked pre-order (bulk line) was delivered automatically at its release date. Also sent, deprecated, beside order.fulfilled when you fulfil a pre-order placed with POST /orders
Seller actionCarries no keys. For a key-locked pre-order, read them with POST /orders/recover-keys and the orderReference, then deliver them. For an order you fulfilled yourself, act on order.fulfilled and ignore this event
DuplicationDedupe; may pair with aggregate changes on GET /orders
RelatedPreorder reservations
JSON
{
  "eventId": "evt_1754385262108_69c534c1597fee70",
  "eventLogId": "evt_1754385262101_12d177f88e9f87d4",
  "eventType": "order.preorder_fulfilled",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "pulled": 1,
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35"
}

order.backorder_expired#

TriggerA customer-order backorder (backorderOnUnavailable) was still awaiting_stock at backorderExpiresAt (default 14 days). Avrix cancelled it and released the allocation headroom
Seller actionRefund the buyer at your PSP and close the store order; no keys will follow
DuplicationDedupe by eventId; GET /orders/{orderId} then reads status: cancelled
RelatedbackorderOnUnavailable on POST /orders, order.ready
JSON
{
  "eventId": "evt_1754385262108_8ec451aeafb44a5d",
  "eventLogId": "evt_1754385262101_e954299750d7fd4a",
  "eventType": "order.backorder_expired",
  "eventVersion": "1",
  "occurredAt": "2026-09-01T10:00:00.000Z",
  "orderReference": "store-order-10433",
  "orderId": "ord_3kq9x2m4v8",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "quantity": 1,
  "status": "cancelled",
  "backorderCreatedAt": "2026-09-01T10:00:00.000Z",
  "expiredAt": "2026-09-15T10:23:00.000Z",
  "recommendedAction": "refund_customer"
}

order.returned#

TriggerOlder name of order.cancelled: you cancelled a pre-order, reservation or backorder with POST /orders/cancel before its keys were delivered. Despite the name, it is not a buyer return of delivered keys: that is order.keys_returned
Seller actionReflect cancellation in your OMS; do not expect key quarantine events. Subscribe to order.cancelled instead; an endpoint subscribed to both receives the cancellation twice, with one eventLogId
DuplicationDedupe by eventLogId
RelatedPOST /api/seller/v1/orders/cancel, order.cancelled
JSON
{
  "eventId": "evt_1754385262108_c20cf715fd9a281e",
  "eventLogId": "evt_1754385262101_acae6b9e3ae79c75",
  "eventType": "order.returned",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "cancelled": 1,
  "reason": "buyer_refund"
}

reason echoes the reason you sent on the cancel call (or null). A cancelled backorder or deferred pre-order carries orderId (ord_…) instead of reason.


order.cancelled#

TriggerYou cancelled a pre-order, reservation or backorder with POST /orders/cancel before its keys were delivered
Seller actionReflect the cancellation in your OMS; no keys were delivered, so nothing is returned
DuplicationDedupe by eventLogId; the order.returned delivery of the same cancellation carries the same one
RelatedPOST /api/seller/v1/orders/cancel, Order lifecycle
JSON
{
  "eventId": "evt_1754385262108_84542daf1338ed18",
  "eventLogId": "evt_1754385262101_c63021e44dad1e3b",
  "eventType": "order.cancelled",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "cancelled": 1,
  "reason": "buyer_refund"
}

The same fields as order.returned: reason echoes the cancel call's reason, and a cancelled backorder or deferred pre-order carries orderId (ord_…) instead.


order.keys_returned#

TriggerSuccessful post-fulfilment key return / quarantine
Seller actionMark keys returned in your vault; stop delivering those keyIds
DuplicationOften paired with refund.completed on the same return — handle both
RelatedPOST /keys/return, POST /refunds
JSON
{
  "eventId": "evt_1754385262108_0a3b9818578830f3",
  "eventLogId": "evt_1754385262101_8800893a0a072d8b",
  "eventType": "order.keys_returned",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "orderReferences": ["store-order-10432"],
  "keyIds": ["8f21a9b0-1234-5678-9abc-def012345678", "9a02b1c3-2345-6789-abcd-ef0123456789"],
  "returned": 2,
  "reason": "buyer_refund"
}

orderReference is set when every returned key came from one order; orderReferences lists them all.


refund.completed#

TriggerPOST /refunds or POST /keys/return recorded a refund or chargeback for the keys
Seller actionAlign your finance ledger; the buyer is refunded at your payment provider, never by Avrix
DuplicationSent next to order.keys_returned (the inventory side); dedupe each event independently
RelatedRefunds and key returns, GET /api/seller/v1/refunds
JSON
{
  "eventId": "evt_1754385262108_d5f399f4e0168258",
  "eventLogId": "evt_1754385262101_bfb1ac387e0d2d6b",
  "eventType": "refund.completed",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "orderReferences": ["store-order-10432"],
  "keyIds": ["8f21a9b0-1234-5678-9abc-def012345678"],
  "returned": 1,
  "reason": "buyer_refund",
  "adjustmentType": "refund",
  "refundReference": "re_store_10432",
  "chargebackReference": null,
  "refundIds": ["7c1e2a90-4b3d-4f6e-9a8b-5d4c3b2a1f0e"],
  "keyDisposition": "quarantined",
  "saleTotals": [{ "currencyCode": "EUR", "salePriceCents": 4999 }]
}

refundReference or chargebackReference is the reference you sent. refundIds are the refund records (GET /refunds/{refundId}), one per key sold under the API model; keys sold under other business models have none. keyDisposition is quarantined, held (revenue-share keys stay with you) or mixed. saleTotals is the sale value of the refunded API-model keys per currency, in minor units. These five fields are absent when the call recorded no refund (a return without adjustment).


chargeback.opened#

TriggerPOST /refunds with type: "chargeback" recorded a chargeback (chargeback_open)
Seller actionFight or accept the dispute at your payment provider; report the outcome with POST /chargebacks/resolve
DuplicationSent next to refund.completed for the same call; dedupe by eventId
RelatedChargebacks, GET /api/seller/v1/refunds?type=chargeback
JSON
{
  "eventId": "evt_1754385262108_4b1c9d2e7f3a6b80",
  "eventLogId": "evt_1754385262101_9e2d4c6b8a0f1e3d",
  "eventType": "chargeback.opened",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "orderReference": "store-order-10432",
  "orderReferences": ["store-order-10432"],
  "chargebackReference": "cb_2026_000187",
  "keyIds": ["8f21a9b0-1234-5678-9abc-def012345678"],
  "refundIds": ["7c1e2a90-4b3d-4f6e-9a8b-5d4c3b2a1f0e"],
  "keyDisposition": "quarantined",
  "saleTotals": [{ "currencyCode": "EUR", "salePriceCents": 4999 }],
  "chargebackOccurredAt": "2026-08-03T00:00:00.000Z",
  "openedAt": "2026-08-05T09:14:22.108Z"
}

chargebackOccurredAt is the occurredAt you sent on POST /refunds, or null.


chargeback.resolved#

TriggerYou reported the outcome of a chargeback with POST /chargebacks/resolve and the sale lines under that chargebackReference moved to chargeback_won or chargeback_lost
Seller actionClose the dispute in your records; align finance with the outcome
DuplicationDedupe by eventId; a repeat of the same resolve call with the same Idempotency-Key replays the stored response and sends no second event
RelatedChargebacks, GET /api/seller/v1/refunds
JSON
{
  "eventId": "evt_1754385262108_d8fa80f9790a8ae4",
  "eventLogId": "evt_1754385262101_d997446ca684dd83",
  "eventType": "chargeback.resolved",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "chargebackReference": "cb_2026_000187",
  "outcome": "won",
  "resolved": 2
}

outcome is won or lost. resolved is the number of sale lines the resolution moved, the same value as in the POST /chargebacks/resolve response.


keys.pulled#

TriggerKeys pulled via POST /api/seller/v1/keys/pull (non-order path)
Seller actionPersist keys from the HTTP response; use webhook for ops correlation only
DuplicationDedupe by eventId
RelatedKey pull API
JSON
{
  "eventId": "evt_1754385262108_d3bedfa413f939ad",
  "eventLogId": "evt_1754385262101_ee4e25b14d87ee75",
  "eventType": "keys.pulled",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "pulled": 1,
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "orderReadableId": "ord_01J8XYZ..."
}

key.replaced#

TriggerA delivered key was replaced by a fresh key from the same allocation (POST /api/seller/v1/orders/{orderId}/keys/{keyId}/replace), at once or after the Content Owner approved it
Seller actionSwap the key in your order record; read the new key from the replace response or POST /orders/recover-keys
DuplicationDedupe by eventId or replacementId
RelatedKey replacement, GET /orders/{orderId} replacements[]

No key plaintext and no new sale.

JSON
{
  "eventId": "evt_1754385262108_161c0442d755c9df",
  "eventLogId": "evt_1754385262101_2b05ecf25d1a2c82",
  "eventType": "key.replaced",
  "eventVersion": "1",
  "occurredAt": "2026-09-25T10:04:11.000Z",
  "replacementId": "5d2c9e1a-7b3f-4c8d-9e0f-1a2b3c4d5e6f",
  "orderId": "ord_01J8XYZ...",
  "orderReference": "ORDER-10042",
  "replacedKeyId": "7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
  "keyId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "reason": "already_redeemed",
  "approval": "auto",
  "replacedAt": "2026-09-25T10:04:11.000Z"
}

key.replacement_rejected#

TriggerThe Content Owner rejected a replacement you requested with POST /api/seller/v1/orders/{orderId}/keys/{keyId}/replace
Seller actionThe original key stays delivered; tell the buyer, or refund with POST /refunds or file a return request with POST /returns
DuplicationDedupe by eventId or replacementId
RelatedKey replacement, GET /orders/{orderId} replacements[]
JSON
{
  "eventId": "evt_1754385262108_3a5c7e9b1d2f4a60",
  "eventLogId": "evt_1754385262101_6f8a0c2e4b6d8f1a",
  "eventType": "key.replacement_rejected",
  "eventVersion": "1",
  "occurredAt": "2026-09-26T08:30:00.000Z",
  "replacementId": "5d2c9e1a-7b3f-4c8d-9e0f-1a2b3c4d5e6f",
  "orderId": "ord_01J8XYZ...",
  "orderReference": "ORDER-10042",
  "keyId": "7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
  "reason": "invalid",
  "decisionNote": "The key activates on our side; please ask the buyer to retry.",
  "rejectedAt": "2026-09-26T08:30:00.000Z"
}

keyId is the key you asked to replace. reason is the reason you gave; decisionNote is the Content Owner's note, when they wrote one.


keys.revoked#

TriggerThe Content Owner revoked keys already sold on one of your orders (leaked batch, grey-market resale, platform revocation, fraud)
Seller actionrecommendedAction: replace → POST /orders/{orderId}/keys/{keyId}/replace per key; refund → POST /refunds
DuplicationDedupe by eventId; one event per order
RelatedKey replacement, GET /orders/{orderId} revocations[], recover-keys revoked[]
JSON
{
  "eventId": "evt_1754385262108_f9b8e8ea9025eb71",
  "eventLogId": "evt_1754385262101_54b25a3d8f18aad5",
  "eventType": "keys.revoked",
  "eventVersion": "1",
  "occurredAt": "2026-09-25T11:20:00.000Z",
  "orderId": "ord_01J8XYZ...",
  "orderReference": "ORDER-10042",
  "keyIds": ["7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f"],
  "reason": "leaked",
  "recommendedAction": "replace",
  "revokedAt": "2026-09-25T11:20:00.000Z"
}

key.frozen#

TriggerYou froze delivered keys for an open dispute (POST /api/seller/v1/disputes/freeze)
Seller actionNone — recover-keys withholds the keys until the freeze ends
DuplicationDedupe by eventId or freezeId
RelatedDispute freezes, key.unfrozen
JSON
{
  "eventId": "evt_1754385262108_fe5d82d3407b6d6c",
  "eventLogId": "evt_1754385262101_570da023b9004d71",
  "eventType": "key.frozen",
  "eventVersion": "1",
  "occurredAt": "2026-10-25T09:00:00.000Z",
  "freezeId": "3b1f6a2c-9d4e-4f7a-8b1c-2d3e4f5a6b7c",
  "keyIds": ["7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f"],
  "orderReferences": ["ORDER-10042"],
  "reason": "payment_dispute",
  "disputeReference": "dp_1Q2w3E",
  "expiresAt": "2026-10-25T09:00:00.000Z"
}

key.unfrozen#

TriggerA dispute freeze ended: you released it, it expired, or POST /refunds refunded or charged back its keys
Seller actionreleased / expired: the keys are recoverable again; refunded / chargeback: nothing more to do
DuplicationDedupe by eventId or freezeId
RelatedDispute freezes, key.frozen
JSON
{
  "eventId": "evt_1754385262108_7f4a67de80d8ce9a",
  "eventLogId": "evt_1754385262101_09915f1a0f626e7a",
  "eventType": "key.unfrozen",
  "eventVersion": "1",
  "occurredAt": "2026-10-02T14:30:00.000Z",
  "freezeId": "3b1f6a2c-9d4e-4f7a-8b1c-2d3e4f5a6b7c",
  "keyIds": ["7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f"],
  "status": "converted",
  "resolution": "chargeback",
  "endedAt": "2026-10-02T14:30:00.000Z"
}

fulfillment.revoked#

TriggerA keyless redemption link was revoked before redemption: by you, by a refund or chargeback, or because the Content Owner revoked the key
Seller actionTell the buyer the link no longer works; refund or re-issue as your policy says
DuplicationDedupe by eventId or fulfillmentId
RelatedKeyless fulfilment, POST /orders/fulfillments/{fulfillmentId}/revoke
JSON
{
  "eventId": "evt_1754385262108_ab981d55e1e3da50",
  "eventLogId": "evt_1754385262101_00501905992f0dea",
  "eventType": "fulfillment.revoked",
  "eventVersion": "1",
  "occurredAt": "2026-09-25T12:00:00.000Z",
  "fulfillmentId": "b7e2c1d4-8a9f-4e3b-9c1d-2e3f4a5b6c7d",
  "orderReference": "ORDER-10042",
  "keyId": "7c1e2d3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
  "linkGroupId": null,
  "provider": "hosted_redemption",
  "reason": "refund",
  "revokedAt": "2026-09-25T12:00:00.000Z"
}

allocation.replenished#

TriggerYour top-up threshold (replenishThreshold, set with PATCH /allocations/{id}) was crossed and the Content Owner's rules topped the allocation up
Seller actionKeep selling; quantityLimit is the new ceiling
DuplicationDedupe by eventId
RelatedGET /allocations/{id}/replenishments, allocation.updated (reason replenished)
JSON
{
  "eventId": "evt_1754385262108_0c0cc7b79c069fb2",
  "eventLogId": "evt_1754385262101_c24e462ab8fbb814",
  "eventType": "allocation.replenished",
  "eventVersion": "1",
  "occurredAt": "2026-09-25T14:00:00.000Z",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "quantity": 50,
  "quantityLimit": 550,
  "remaining": 58,
  "threshold": 10,
  "trigger": "threshold",
  "replenishedAt": "2026-09-25T14:00:00.000Z"
}

redemption.expiring#

TriggerA keyless redemption URL enters its expiry notice window (~24 hours before expiresAt)
Seller actionNudge the buyer to redeem; after expiry, follow the keyless re-issue path
DuplicationFires once per fulfillment
RelatedKeyless fulfillment, order.activated

Payload carries ids only — never the redemption URL or token.

JSON
{
  "eventId": "evt_1754385262108_0bad9837cb9fb931",
  "eventLogId": "evt_1754385262101_1e775e9671c2e9fa",
  "eventType": "redemption.expiring",
  "eventVersion": "1",
  "occurredAt": "2026-08-13T02:00:00.000Z",
  "fulfillmentId": "8f21a9b0-1234-5678-9abc-def012345678",
  "orderReference": "store-order-10432",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "platformCode": "steam",
  "provider": "hosted_redemption",
  "expiresAt": "2026-08-13T02:00:00.000Z"
}

allocation.updated#

TriggerAllocation capacity or metadata changed
Seller actionRefresh GET /allocations / availability for the SKU
DuplicationCollapse bursts into one refresh
RelatedAllocations, catalog sync
JSON
{
  "eventId": "evt_1754385262108_dff74dbd9f474e82",
  "eventLogId": "evt_1754385262101_dbf000acd491c6fd",
  "eventType": "allocation.updated",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "publisherCompanyId": "content-owner-co",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "quantityLimit": 500,
  "quantityPulled": 80,
  "remaining": 420,
  "reason": "pulled"
}

allocation.depleted#

TriggerAllocation reached zero remaining
Seller actionMark SKU unavailable on the storefront; re-check on next allocation update
DuplicationTreat as authoritative “empty” signal; still re-read allocations
RelatedAvailability
JSON
{
  "eventId": "evt_1754385262108_ab943d28732e9a97",
  "eventLogId": "evt_1754385262101_fb1094cf275c2cc6",
  "eventType": "allocation.depleted",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "publisherCompanyId": "content-owner-co",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "quantityLimit": 500,
  "quantityPulled": 500,
  "remaining": 0,
  "reason": "pulled"
}

allocation.low_stock#

TriggerAn allocation update left remaining at or below 10% of quantityLimit, and above zero. The 10% is fixed: it is not configurable, and it is not the replenishThreshold you set for automatic top-ups
Seller actionAlert merchandising / pause promotions if needed
DuplicationSent with every allocation.updated while the allocation stays at or below 10%, so expect one per pull, not one per crossing. Act on the first and ignore the rest until remaining rises above 10% again; do not decrement local counters blindly. For one event per crossing, subscribe to allocation.running_low instead
RelatedAllocations, allocation.running_low, allocation.depleted (sent instead when remaining reaches zero), allocation.replenished
JSON
{
  "eventId": "evt_1754385262108_13c49d479994b56e",
  "eventLogId": "evt_1754385262101_571202d7a6673815",
  "eventType": "allocation.low_stock",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "publisherCompanyId": "content-owner-co",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "quantityLimit": 500,
  "quantityPulled": 475,
  "remaining": 25,
  "threshold": 50,
  "reason": "pulled"
}

threshold is the line this event used: 10% of quantityLimit, rounded down.


allocation.running_low#

Triggerremaining fell to or below the allocation's low-stock threshold. The threshold is your replenishThreshold on the allocation (PATCH /allocations/{id}) when you set one, otherwise 10% of quantityLimit, rounded down; thresholdSource says which
Seller actionReorder, ask for more keys (POST /allocations/requests), or warn merchandising. One event is one fall, so it is safe to page someone on it
DuplicationSent once per crossing. It is sent again only after remaining has risen above the threshold (a top-up, a larger ceiling, a returned key) and fallen to it again. Dedupe by eventLogId
Relatedallocation.low_stock (fixed 10%, repeated while low), allocation.depleted, allocation.replenished, GET /allocations/{id}
JSON
{
  "eventId": "evt_1754385262108_7d0e2a5c91b34f68",
  "eventLogId": "evt_1754385262101_2b8f6c1e04a9d375",
  "eventType": "allocation.running_low",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T09:14:22.108Z",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "publisherCompanyId": "content-owner-co",
  "quantityLimit": 500,
  "quantityPulled": 440,
  "remaining": 60,
  "threshold": 60,
  "thresholdSource": "replenish_threshold",
  "crossedAt": "2026-12-01T09:14:22.101Z"
}

A pull that takes remaining to zero in one step sends allocation.running_low and allocation.depleted. A paused or revoked allocation does not send it.


allocation.request_decided#

TriggerAn allocation request you filed with POST /allocations/requests was decided: approved or denied by the Content Owner, or granted at once by the Content Owner's rules (auto_granted)
Seller actionOn approved or auto_granted, read the allocation (allocationId) and make the SKU sellable; on denied, stop waiting and show decisionNote to whoever filed the request
DuplicationDedupe by eventLogId; one request is decided once
RelatedPOST /allocations/requests, GET /allocations
JSON
{
  "eventId": "evt_1754385262108_5ff5cb670c0ab31c",
  "eventLogId": "evt_1754385262101_de78a129f7c146fe",
  "eventType": "allocation.request_decided",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "requestId": "2c7e9b14-5a3d-4f81-b6e2-9d0c1a8f3e57",
  "resolution": "approved",
  "automatic": false,
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "publisherCompanyId": "content-owner-co",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "requestedQuantity": 500,
  "grantedQuantity": 250,
  "decisionNote": "Half now, the rest after launch week.",
  "decidedAt": "2026-12-01T10:00:00.101Z"
}

grantedQuantity is 0 and allocationId is null when the request was denied.


allocation.request_cancelled#

TriggerA pending allocation request was withdrawn by your company, with POST /allocations/requests/{id}/cancel or in the console, before the Content Owner decided it
Seller actionStop waiting on it. A second integration or a person in the console may have cancelled it, so read GET /allocations/requests/{id} before filing again
DuplicationDedupe by eventLogId; a request is cancelled once
Relatedallocation.request_decided, GET /allocations/requests
JSON
{
  "eventId": "evt_1754385262108_c3a91f5e2d7b4086",
  "eventLogId": "evt_1754385262101_8e4d0b7a6c1f2935",
  "eventType": "allocation.request_cancelled",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:05:00.101Z",
  "requestId": "2c7e9b14-5a3d-4f81-b6e2-9d0c1a8f3e57",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "publisherCompanyId": "content-owner-co",
  "allocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "requestedQuantity": 500,
  "cancelledAt": "2026-12-01T10:05:00.101Z"
}

product.added#

TriggerA product entered your catalog: an agreement or a share now lets you sell it
Seller actionRead it with GET /products/{id} and its SKUs with GET /allocations; list it once a SKU is sellable (sku.sellability_changed)
DuplicationDedupe by eventLogId. A product that leaves and enters your catalog again sends it again
RelatedGET /catalog/changes (the same change as a row with eventType: added), product.delisted
JSON
{
  "eventId": "evt_1754385262108_f45b5b10b28160f3",
  "eventLogId": "evt_1754385262101_fc74b8d4054ee595",
  "eventType": "product.added",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "productId": "7c4b8e10-95a2-4f3d-8b61-0d2e5a7c9314",
  "publisherCompanyId": "content-owner-co"
}

Recorded in the same database transaction as the catalog change, so it is never lost when the change commits.


product.updated#

TriggerProduct metadata changed for a shared product
Seller actionRun incremental catalog sync (GET /catalog/changes or products delta)
DuplicationCoalesce into one sync job
RelatedCatalog

changedFields names what changed, in the vocabulary of GET /catalog/changes (metadata, relationships, ...), once each, when the change that sent the event knows it. It is absent otherwise: refetch the whole product then.

JSON
{
  "eventId": "evt_1754385262108_de2869d42ee1d302",
  "eventLogId": "evt_1754385262101_75d3b808ad4d115c",
  "eventType": "product.updated",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "productId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "publisherCompanyId": "content-owner-co",
  "productName": "Example Game",
  "productSlug": "example-game",
  "productStatus": "active",
  "launchPhase": "available",
  "tradingState": "open",
  "isArchived": false,
  "updatedAt": "2026-08-05T09:14:22.108Z",
  "changedFields": ["metadata"]
}

product.announced#

TriggerRelease advanced to announced
Seller actionUpdate storefront presentation / preorder messaging
DuplicationIdempotent presentation update
RelatedProduct lifecycle
JSON
{
  "eventId": "evt_1754385262108_586b3e7deb5d4e74",
  "eventLogId": "evt_1754385262101_6ef20fdce8ae2703",
  "eventType": "product.announced",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "productId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "releaseId": "7c4b8e10-95a2-4f3d-8b61-0d2e5a7c9314",
  "publisherCompanyId": "content-owner-co",
  "launchPhase": "announced",
  "emittedAt": "2026-08-05T09:14:22.108Z"
}

redemption.expired#

TriggerA keyless redemption URL has passed expiresAt without activation
Seller actionMark the link dead; do not send the buyer to it. Re-issue only if your process allows
DuplicationFires once per fulfillment (expiry_expired_at marker)
Relatedredemption.expiring, keyless fulfillment

Payload carries ids only — never the redemption URL or token.

JSON
{
  "eventId": "evt_1754385262108_447a62324c956ed8",
  "eventLogId": "evt_1754385262101_1ff875eb6ef4d28c",
  "eventType": "redemption.expired",
  "eventVersion": "1",
  "occurredAt": "2026-08-13T02:00:00.000Z",
  "fulfillmentId": "8f21a9b0-1234-5678-9abc-def012345678",
  "orderReference": "store-order-10432",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "platformCode": "steam",
  "provider": "hosted_redemption",
  "expiresAt": "2026-08-13T02:00:00.000Z",
  "effectiveAt": "2026-08-13T02:00:00.000Z"
}

product.delisted#

TriggerProduct removed from your visible catalog (tombstone)
Seller actionRemove or hide the product; stop taking new orders
DuplicationTreat as tombstone; confirm via GET /catalog/changes
RelatedCatalog changes
JSON
{
  "eventId": "evt_1754385262108_d13d82b941a71f4d",
  "eventLogId": "evt_1754385262101_07a02aae72773ad7",
  "eventType": "product.delisted",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "productId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "publisherCompanyId": "content-owner-co",
  "productName": "Example Game",
  "productSlug": "example-game",
  "productStatus": "archived",
  "launchPhase": "available",
  "tradingState": "discontinued",
  "isArchived": true,
  "updatedAt": "2026-08-05T09:14:22.108Z"
}

product.delisting_scheduled#

TriggerProduct has a future archived_at — it will leave the catalog at effectiveAt
Seller actionSchedule delist in your store; do not treat as already gone. Immediate archive still emits product.delisted only
DuplicationTreat as advance notice; confirm via GET /catalog/changes
Relatedproduct.delisted, catalog changes
JSON
{
  "eventId": "evt_1754385262108_87073f422ccfa80e",
  "eventLogId": "evt_1754385262101_129ac2f177cdb65c",
  "eventType": "product.delisting_scheduled",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "productId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "publisherCompanyId": "content-owner-co",
  "productName": "Example Game",
  "productSlug": "example-game",
  "productStatus": "active",
  "launchPhase": "available",
  "tradingState": "open",
  "isArchived": false,
  "updatedAt": "2026-08-05T09:14:22.108Z",
  "effectiveAt": "2026-09-01T00:00:00.000Z"
}

catalog.export_ready#

TriggerAn async POST /catalog/exports job finished building the gzip NDJSON artifact
Seller actionGET /catalog/exports/{exportId} for the short-lived signed URL
DuplicationOnce per export job
RelatedCatalog snapshot
JSON
{
  "eventId": "evt_1754385262108_088dfb62fb1b06e4",
  "eventLogId": "evt_1754385262101_ab01943dbbf1cdf1",
  "eventType": "catalog.export_ready",
  "eventVersion": "1",
  "occurredAt": "2026-08-18T12:00:00.000Z",
  "exportId": "5d1e7f90-3a2b-4c6d-8e9f-0a1b2c3d4e5f",
  "checksum": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "bytes": 1048576,
  "expiresAt": "2026-08-18T12:00:00.000Z",
  "totalProducts": 1200
}

release.available#

TriggerRelease advanced to available
Seller actionRefresh catalog and sellability; enable purchase UI when allocations allow
DuplicationIdempotent
RelatedProduct lifecycle, allocations
JSON
{
  "eventId": "evt_1754385262108_5eafa6a70a65e9f6",
  "eventLogId": "evt_1754385262101_c5f64f2df88cf1de",
  "eventType": "release.available",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "productId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "releaseId": "7c4b8e10-95a2-4f3d-8b61-0d2e5a7c9314",
  "publisherCompanyId": "content-owner-co",
  "launchPhase": "available",
  "emittedAt": "2026-08-05T09:14:22.108Z"
}

release.date_changed#

TriggerPublisher moved a release date (pre-order slip signal)
Seller actionUpdate listing dates; notify pre-order buyers; re-check pre-order windows
DuplicationLatest date wins; compare newDate against your stored value
RelatedPre-orders, order.reserved, product lifecycle
JSON
{
  "eventId": "evt_1754385262108_c6c81a0bb91d3b13",
  "eventLogId": "evt_1754385262101_9e21ded56fc29d7f",
  "eventType": "release.date_changed",
  "eventVersion": "1",
  "occurredAt": "2026-11-14T00:00:00.000Z",
  "productId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "releaseId": "7c4b8e10-95a2-4f3d-8b61-0d2e5a7c9314",
  "skuIds": ["3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35"],
  "publisherCompanyId": "content-owner-co",
  "oldDate": "2026-11-14T00:00:00.000Z",
  "newDate": "2027-02-06T00:00:00.000Z",
  "emittedAt": "2026-08-05T09:14:22.108Z"
}

sku.pricing_updated#

TriggerTerritory catalog list price changed for a SKU
Seller actionRefresh pricing; re-preview before next charge
DuplicationLatest price wins; do not apply deltas blindly
RelatedGET /products/{id}/pricing, order preview
JSON
{
  "eventId": "evt_1754385262108_81fb75b6e9b0bd7a",
  "eventLogId": "evt_1754385262101_bd79cf618553039b",
  "eventType": "sku.pricing_updated",
  "eventVersion": "1",
  "occurredAt": "2026-08-12T09:00:00.000Z",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "productId": "7c4b8e10-95a2-4f3d-8b61-0d2e5a7c9314",
  "publisherCompanyId": "content-owner-co",
  "countryCode": "US",
  "priceCents": 1999,
  "priceMinor": 1999,
  "currencyCode": "USD",
  "currencyExponent": 2,
  "pricingMode": "override_manual",
  "updatedAt": "2026-08-12T09:00:00.000Z",
  "effectiveAt": "2026-08-12T09:00:00.000Z",
  "previousPricing": { "priceCents": 2499, "priceMinor": 2499, "currencyCode": "USD", "currencyExponent": 2 },
  "newPricing": { "priceCents": 1999, "priceMinor": 1999, "currencyCode": "USD", "currencyExponent": 2 }
}

effectiveAt states when the new price takes effect. For immediate changes it equals the event's updatedAt; scheduled price changes stamp a future instant — apply the new price at that boundary rather than on receipt. previousPricing / newPricing carry the explicit old→new pair (previousPricing is null when no prior price existed for the country). Every price is an integer in minor units with its own currencyExponent (previousPricing can be in another currency than newPricing); see Money fields. priceMinor is the price under the name every amount uses; priceCents is its older name, with the same value.


sku.sellability_changed#

TriggerA shared SKU crossed the sellable boundary (any of the four gates flipped), or a SKU you can sell appeared for the first time (firstSeen: true)
Seller actionEnable/disable the Buy button; confirm with GET /allocations before checkout
DuplicationState event — apply the latest sellable value
RelatedFour sellability gates, GET /allocations, readinessBlockers
JSON
{
  "eventId": "evt_1754385262108_d10d170fe0ec552c",
  "eventLogId": "evt_1754385262101_9e4db2f0d40f7ca2",
  "eventType": "sku.sellability_changed",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "skuId": "3f9a1c22-7b6d-4e51-9f0a-2c8e4d6b1a35",
  "skuCode": "SANDBOX-ALWAYS-001",
  "productId": "7c4b8e10-95a2-4f3d-8b61-0d2e5a7c9314",
  "sellable": false,
  "reasons": ["NO_SKU_SHARE"],
  "firstSeen": false,
  "emittedAt": "2026-08-05T09:14:22.108Z"
}

firstSeen is true when Avrix had not seen the SKU for your company before and it is sellable now. The very first time Avrix observes your catalog it records every SKU without sending events, so a new integration is not flooded; use GET /allocations for that first picture.


contract.activated#

TriggerBMA or MCA became active
Seller actionRe-sync partners / catalog; SKUs under the contract may become sellable
DuplicationIdempotent commercial refresh
RelatedPartners, four sellability gates
JSON
{
  "eventId": "evt_1754385262108_df903c03ee83c448",
  "eventLogId": "evt_1754385262101_5a5a7f3ce681f183",
  "eventType": "contract.activated",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "contractType": "api",
  "termId": "6e5d4c3b-2a19-4870-b6c5-d4e3f2a1b098",
  "version": 3
}

contract.superseded#

TriggerPrior active contract term was superseded
Seller actionRefresh commercial terms; stop relying on the old term id
DuplicationIdempotent
RelatedContract lifecycle
JSON
{
  "eventId": "evt_1754385262108_8e28b78e16543626",
  "eventLogId": "evt_1754385262101_4fa8501dc9c3f82a",
  "eventType": "contract.superseded",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "contractType": "api",
  "termId": "6e5d4c3b-2a19-4870-b6c5-d4e3f2a1b098",
  "version": 2
}

contract.amendment_accepted#

TriggerAmendment accepted by the counterparty
Seller actionRefresh terms that affect pricing, territory, or scope
DuplicationIdempotent
RelatedContract amendments
JSON
{
  "eventId": "evt_1754385262108_2caa446356e19618",
  "eventLogId": "evt_1754385262101_24b5a635cfd6f91c",
  "eventType": "contract.amendment_accepted",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "contractType": "api",
  "termId": "6e5d4c3b-2a19-4870-b6c5-d4e3f2a1b098",
  "version": 4
}

contract.expiring#

TriggerAn agreement term reaches its end date (validUntil) soon and has not been renewed. Sent about 30, 14 and 7 days ahead; windowDays says which
Seller actionAsk the Content Owner to renew, or plan to stop selling the SKUs under the term
DuplicationDedupe by eventLogId; each window is sent once
RelatedGET /contracts, contract.expired
JSON
{
  "eventId": "evt_1754385262108_cc373a8d29328d74",
  "eventLogId": "evt_1754385262101_0d496bef5b536d67",
  "eventType": "contract.expiring",
  "eventVersion": "1",
  "occurredAt": "2026-12-15T00:00:00.000Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "contractType": "api",
  "termId": "6e5d4c3b-2a19-4870-b6c5-d4e3f2a1b098",
  "validUntil": "2026-12-15T00:00:00.000Z",
  "windowDays": 14,
  "changedAt": "2026-12-01T10:00:00.101Z"
}

contract.expired#

TriggerAn agreement term passed its end date without renewal
Seller actionStop selling under the term: new allocations and orders under it fail until a new term is active (contract.activated)
DuplicationDedupe by eventLogId
RelatedGET /contracts, contract.activated
JSON
{
  "eventId": "evt_1754385262108_1af63e7faf0f6033",
  "eventLogId": "evt_1754385262101_0c8517628a507bd3",
  "eventType": "contract.expired",
  "eventVersion": "1",
  "occurredAt": "2026-11-30T23:59:59.000Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "contractType": "api",
  "termId": "6e5d4c3b-2a19-4870-b6c5-d4e3f2a1b098",
  "validUntil": "2026-11-30T23:59:59.000Z",
  "changedAt": "2026-12-01T00:05:00.000Z"
}

contract.terminated#

TriggerA notice of termination was given on an agreement term and its notice period has ended
Seller actionStop selling under the term; re-read GET /contracts and GET /allocations
DuplicationDedupe by eventLogId
RelatedGET /contracts, connection.ended
JSON
{
  "eventId": "evt_1754385262108_ae81e3560ca52a68",
  "eventLogId": "evt_1754385262101_dbba0c69c19406b5",
  "eventType": "contract.terminated",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T00:05:00.000Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "contractType": "api",
  "termId": "6e5d4c3b-2a19-4870-b6c5-d4e3f2a1b098",
  "changedAt": "2026-12-01T00:05:00.000Z"
}

connection.suspended#

TriggerThe Content Owner suspended your connection
Seller actionPause sales of that Content Owner's SKUs: its shares and allocations are paused until the connection is reactivated
DuplicationDedupe by eventLogId
Relatedconnection.reactivated, GET /allocations
JSON
{
  "eventId": "evt_1754385262108_acb2dd1d07b585cc",
  "eventLogId": "evt_1754385262101_1910586335969bd6",
  "eventType": "connection.suspended",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "initiatedBy": "publisher",
  "changedAt": "2026-12-01T10:00:00.101Z"
}

connection.reactivated#

TriggerA suspended connection was reactivated
Seller actionRe-read GET /allocations; SKUs become sellable again as their gates allow (sku.sellability_changed)
DuplicationDedupe by eventLogId
Relatedconnection.suspended
JSON
{
  "eventId": "evt_1754385262108_2a71628a221a843d",
  "eventLogId": "evt_1754385262101_c493c8ce3c883c34",
  "eventType": "connection.reactivated",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "initiatedBy": "publisher",
  "changedAt": "2026-12-01T10:00:00.101Z"
}

connection.ended#

TriggerYour connection with a Content Owner was closed: by the Content Owner (publisher), by your company (seller), or by the platform because no agreement remains (platform)
Seller actionStop selling that Content Owner's SKUs and remove them from your storefront
DuplicationDedupe by eventLogId
Relatedcontract.terminated, product.delisted
JSON
{
  "eventId": "evt_1754385262108_31a4ef94a4d5128a",
  "eventLogId": "evt_1754385262101_6900578cede362fc",
  "eventType": "connection.ended",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publisherCompanyId": "content-owner-co",
  "initiatedBy": "seller",
  "changedAt": "2026-12-01T10:00:00.101Z"
}

connection.request_decided#

TriggerA Content Owner approved or rejected a connection request your company sent. Not sent for a Content Owner's invitation, which you accept or decline yourself, or for a request you withdraw
Seller actionapproved: the connection exists under connectionId, and its agreements still need signing in the console; you can trade once contract.activated arrives. rejected: read reviewNote; the request stays on GET /partners?status=rejected
DuplicationDedupe by eventLogId; one event per decision
RelatedGET /partners, contract.activated, Partner onboarding
JSON
{
  "eventId": "evt_1754385262108_5b0d7e21c4a39f86",
  "eventLogId": "evt_1754385262101_9c4e2a71d58b3f06",
  "eventType": "connection.request_decided",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "requestId": "3f8a1c5e-9b27-4d60-a4e1-7c2b9d5f0e18",
  "decision": "approved",
  "publisherCompanyId": "content-owner-co",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "reviewNote": null,
  "requestedAt": "2026-11-28T09:15:00.000Z",
  "decidedAt": "2026-12-01T10:00:00.101Z"
}

A rejection carries decision: "rejected", connectionId: null and the Content Owner's note in reviewNote (null when they left none). Until the decision, GET /partners lists the request with connectionId equal to its requestId; after an approval the partner row carries the new connectionId this event names.


access.proposal_created#

TriggerA Content Owner proposed more countries (proposalType: territory_added) or a currency (currency_added) on a connection
Seller actionReview it with GET /access/proposals and answer with POST /access/proposals/{id}/accept or /decline
DuplicationDedupe by eventLogId; proposalId is the proposal's id
RelatedGET /access/proposals
JSON
{
  "eventId": "evt_1754385262108_88169a5ca92c48f6",
  "eventLogId": "evt_1754385262101_f2babcdccd96d7b8",
  "eventType": "access.proposal_created",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "proposalId": "9e4b2d71-6c38-4a05-b1f7-2d8c5e9a0b36",
  "proposalType": "territory_added",
  "connectionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "contractTermId": "6e5d4c3b-2a19-4870-b6c5-d4e3f2a1b098",
  "publisherCompanyId": "content-owner-co",
  "effectiveFrom": null,
  "proposedAt": "2026-12-01T10:00:00.101Z"
}

return.decided#

TriggerThe Content Owner approved or rejected a key return request you filed
Seller actionOn approved, settle with the buyer as resolution says (refund or replacement); on rejected, show decisionNote to whoever filed it
DuplicationDedupe by eventLogId; one request is decided once
RelatedRefunds and key returns, return.information_requested
JSON
{
  "eventId": "evt_1754385262108_e7729d741a7ee2b1",
  "eventLogId": "evt_1754385262101_3f369e8eae32d764",
  "eventType": "return.decided",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "returnRequestId": "5d0f8a3e-2b71-4c96-a8e4-3f1b9c7d2e05",
  "decision": "approved",
  "resolution": "refund",
  "publisherCompanyId": "content-owner-co",
  "keyCount": 2,
  "decisionNote": null,
  "decidedAt": "2026-12-01T10:00:00.101Z"
}

return.information_requested#

TriggerThe Content Owner needs more information before deciding a key return request you filed
Seller actionAnswer in the console; the request waits until you do
DuplicationDedupe by eventLogId
RelatedRefunds and key returns, return.decided
JSON
{
  "eventId": "evt_1754385262108_8d00e22dd0e657d3",
  "eventLogId": "evt_1754385262101_536d51db80648406",
  "eventType": "return.information_requested",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "returnRequestId": "5d0f8a3e-2b71-4c96-a8e4-3f1b9c7d2e05",
  "publisherCompanyId": "content-owner-co",
  "requestedAt": "2026-12-01T10:00:00.101Z"
}

promotion.offered#

TriggerA vendor sent you a promotion: a share of a platform event or a custom deal
Seller actionRead the offer by sourceType and sourceId, then accept or decline it before respondBy
DuplicationDedupe by eventLogId; an offer is sent once
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType
JSON
{
  "eventId": "evt_1754385262108_0a1b2c3d4e5f6071",
  "eventLogId": "evt_1754385262101_9a8b7c6d5e4f3021",
  "eventType": "promotion.offered",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "pending",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z"
}

promotion.changed#

TriggerThe vendor changed the products or discounts of a promotion offered to you
Seller actionRead the offer again. When answerAgain is true your acceptance was reset to pending: answer it again before respondBy
DuplicationDedupe by eventLogId; each change is a new event
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType
JSON
{
  "eventId": "evt_1754385262108_1b2c3d4e5f607182",
  "eventLogId": "evt_1754385262101_8b7c6d5e4f302132",
  "eventType": "promotion.changed",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "pending",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z",
  "changes": { "addedCount": 1, "removedCount": 0, "updatedCount": 2 },
  "answerAgain": true
}

promotion.accepted#

TriggerYour company accepted a promotion, over the API or in the console
Seller actionStage the discounted prices for startDate; GET /promotions/shares/{shareId}/discounts lists them
DuplicationDedupe by eventLogId; an offer is answered once
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType
JSON
{
  "eventId": "evt_1754385262108_2c3d4e5f60718293",
  "eventLogId": "evt_1754385262101_7c6d5e4f30213243",
  "eventType": "promotion.accepted",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "accepted",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z"
}

promotion.declined#

TriggerYour company declined a promotion, over the API or in the console
Seller actionNone; the offer stays in your lists with this status
DuplicationDedupe by eventLogId; an offer is answered once
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType
JSON
{
  "eventId": "evt_1754385262108_3d4e5f60718293a4",
  "eventLogId": "evt_1754385262101_6d5e4f3021324354",
  "eventType": "promotion.declined",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "declined",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z"
}

promotion.withdrawn#

TriggerThe vendor withdrew a promotion offered to you or one you had accepted
Seller actionStop showing its discounts at once, even inside the window
DuplicationDedupe by eventLogId
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType
JSON
{
  "eventId": "evt_1754385262108_4e5f60718293a4b5",
  "eventLogId": "evt_1754385262101_5e4f302132435465",
  "eventType": "promotion.withdrawn",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "vendor_withdrawn",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z"
}

promotion.expired#

TriggerA promotion offered to you was not answered by respondBy
Seller actionNone; it can no longer be accepted
DuplicationDedupe by eventLogId; an offer expires once
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType
JSON
{
  "eventId": "evt_1754385262108_5f60718293a4b5c6",
  "eventLogId": "evt_1754385262101_4f30213243546576",
  "eventType": "promotion.expired",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "expired",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z"
}

promotion.started#

TriggerAn accepted promotion's window opened; sent within about 15 minutes of startDate
Seller actionShow the discounted prices; catalogue prices now carry the promotion in listPromo and advertisedPriceCents
DuplicationDedupe by eventLogId; sent once per offer
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType, promotion.ended
JSON
{
  "eventId": "evt_1754385262108_60718293a4b5c6d7",
  "eventLogId": "evt_1754385262101_3021324354657687",
  "eventType": "promotion.started",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "accepted",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z"
}

promotion.ended#

TriggerAn accepted promotion's window closed; sent within about 15 minutes of endDate
Seller actionGo back to the list price
DuplicationDedupe by eventLogId; sent once per offer
RelatedPromotions, GET /promotions/shares/{shareId} or GET /promotions/deals/{responseId} by sourceType, promotion.started
JSON
{
  "eventId": "evt_1754385262108_718293a4b5c6d7e8",
  "eventLogId": "evt_1754385262101_2132435465768798",
  "eventType": "promotion.ended",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "sourceType": "event",
  "sourceId": "8c2f0b6e-4d19-4a7e-9f3c-1e5d7a9b2c40",
  "publisherCompanyId": "content-owner-co",
  "name": "Spring Sale",
  "status": "accepted",
  "startDate": "2026-12-08T00:00:00.000Z",
  "endDate": "2026-12-15T00:00:00.000Z",
  "respondBy": "2026-12-06T00:00:00.000Z"
}

invoice.created#

TriggerSeller invoice document created
Seller actionFetch finance / invoice surfaces; notify accounting
DuplicationDedupe by invoiceId
RelatedFinance endpoints
JSON
{
  "eventId": "evt_1754385262108_fb6d27790767e934",
  "eventLogId": "evt_1754385262101_94b4dd07c71686ae",
  "eventType": "invoice.created",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "invoiceId": "0b9a8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d",
  "publisherCompanyId": "content-owner-co",
  "sellerAllocationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "totalCents": 250000,
  "totalMinor": 250000,
  "currencyCode": "USD",
  "currencyExponent": 2,
  "invoiceType": "proforma",
  "businessModel": "wholesale",
  "createdAt": "2026-08-05T09:14:22.108Z"
}

invoice.issued#

TriggerA Content Owner issued a monthly invoice to you
Seller actionBook it in accounting; status says whether it is payable now (payable) or waits for the commission document (awaiting_commission_document). Read it with GET /finance/invoices/{invoiceId} (lines, payment reference, document)
DuplicationDedupe by eventLogId
RelatedGET /finance/invoices/{invoiceId}, invoice.paid, invoice.overdue

A corrected invoice also carries replacesInvoiceId, the invoice it replaces; that one is now superseded and must not be paid.

JSON
{
  "eventId": "evt_1754385262108_ed7e3103ed9b47b4",
  "eventLogId": "evt_1754385262101_3eb276944c87ae4f",
  "eventType": "invoice.issued",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "invoiceId": "4f1e2d3c-5b6a-4798-8a1b-2c3d4e5f6a7b",
  "invoiceNumber": "CO-2026-0112",
  "platformInvoiceNumber": "INV-2026-000412",
  "supplierInvoiceNumber": "CO-2026-0112",
  "publisherCompanyId": "content-owner-co",
  "status": "payable",
  "totalCents": 1250000,
  "totalMinor": 1250000,
  "currencyCode": "EUR",
  "currencyExponent": 2,
  "issuedAt": "2026-12-01T10:00:00.101Z",
  "dueAt": "2026-12-31T23:59:59.000Z"
}

invoice.paid#

TriggerYour payment of a monthly invoice was recorded
Seller actionMark the invoice paid in accounting
DuplicationDedupe by eventLogId
RelatedGET /finance/invoices, invoice.issued
JSON
{
  "eventId": "evt_1754385262108_0feb240f9cea5746",
  "eventLogId": "evt_1754385262101_1a9e3a625eb0c3c9",
  "eventType": "invoice.paid",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "invoiceId": "4f1e2d3c-5b6a-4798-8a1b-2c3d4e5f6a7b",
  "invoiceNumber": "CO-2026-0112",
  "platformInvoiceNumber": "INV-2026-000412",
  "supplierInvoiceNumber": "CO-2026-0112",
  "publisherCompanyId": "content-owner-co",
  "status": "paid",
  "totalCents": 1250000,
  "totalMinor": 1250000,
  "currencyCode": "EUR",
  "currencyExponent": 2,
  "issuedAt": "2026-12-01T10:00:00.101Z",
  "dueAt": "2026-12-31T23:59:59.000Z",
  "paidAt": "2026-12-20T08:12:44.000Z"
}

invoice.overdue#

TriggerA monthly invoice passed its dueAt unpaid (checked once a day)
Seller actionPay it; it stays payable. Read the payment reference on GET /finance/payments?invoiceId=
DuplicationDedupe by eventLogId; fires once per invoice
RelatedGET /finance/invoices?status=overdue, invoice.paid
JSON
{
  "eventId": "evt_1754385262108_7c41d0a2b9e35f18",
  "eventLogId": "evt_1754385262101_52e8a1f0c7d34b96",
  "eventType": "invoice.overdue",
  "eventVersion": "1",
  "occurredAt": "2027-01-01T03:00:00.412Z",
  "invoiceId": "4f1e2d3c-5b6a-4798-8a1b-2c3d4e5f6a7b",
  "invoiceNumber": "CO-2026-0112",
  "publisherCompanyId": "content-owner-co",
  "status": "overdue",
  "totalCents": 1250000,
  "currencyCode": "EUR",
  "currencyExponent": 2,
  "issuedAt": "2026-12-01T10:00:00.101Z",
  "dueAt": "2026-12-31T23:59:59.000Z"
}

invoice.disputed#

TriggerYou disputed a monthly invoice in the console
Seller actionNone needed; payment is paused until the vendor answers (invoice.dispute_updated). The dispute is on GET /finance/invoices/{invoiceId} under disputes
DuplicationDedupe by eventLogId
Relatedinvoice.dispute_updated, GET /finance/invoices/{invoiceId}
JSON
{
  "eventId": "evt_1754385262108_a90c3e5d7b1f4628",
  "eventLogId": "evt_1754385262101_3d7f9b2e6a04c815",
  "eventType": "invoice.disputed",
  "eventVersion": "1",
  "occurredAt": "2026-12-04T14:21:09.330Z",
  "invoiceId": "4f1e2d3c-5b6a-4798-8a1b-2c3d4e5f6a7b",
  "invoiceNumber": "CO-2026-0112",
  "publisherCompanyId": "content-owner-co",
  "status": "disputed",
  "totalCents": 1250000,
  "currencyCode": "EUR",
  "currencyExponent": 2,
  "issuedAt": "2026-12-01T10:00:00.101Z",
  "dueAt": "2026-12-31T23:59:59.000Z",
  "disputeId": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
}

invoice.dispute_updated#

TriggerThe vendor answered your dispute, or you withdrew it
Seller actionRead outcome. rejected or withdrawn: the invoice is payable again (status: payable). accepted: wait for the corrected invoice (invoice.issued with replacesInvoiceId). escalated: Avrix finance decides, and the invoice stays paused. A dispute raised before dueAt gives you back the days you waited
DuplicationDedupe by eventLogId
Relatedinvoice.disputed, invoice.issued
JSON
{
  "eventId": "evt_1754385262108_e2b5f8a1c4d70936",
  "eventLogId": "evt_1754385262101_6f1a4c9e2b8d0753",
  "eventType": "invoice.dispute_updated",
  "eventVersion": "1",
  "occurredAt": "2026-12-06T09:45:12.004Z",
  "invoiceId": "4f1e2d3c-5b6a-4798-8a1b-2c3d4e5f6a7b",
  "invoiceNumber": "CO-2026-0112",
  "publisherCompanyId": "content-owner-co",
  "status": "payable",
  "totalCents": 1250000,
  "currencyCode": "EUR",
  "currencyExponent": 2,
  "issuedAt": "2026-12-01T10:00:00.101Z",
  "dueAt": "2026-12-31T23:59:59.000Z",
  "disputeId": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "outcome": "rejected"
}

invoice.created is the pro-forma invoice of an allocation; invoice.issued, invoice.overdue, invoice.disputed, invoice.dispute_updated and invoice.paid follow the monthly invoices a Content Owner raises for your sales.

An invoice has two numbers. platformInvoiceNumber is the number Avrix gives it, the one GET /finance/invoices lists; supplierInvoiceNumber is the number on the Content Owner's own document, null when they use none. Match the events to the list on either. invoiceNumber is the older name and keeps its value: the supplier number when there is one, otherwise the platform number, while GET /finance/invoices sends the platform number under that name.


report.ready#

TriggerA monthly sales report was built for a vendor and month
Seller actionRead it with GET /finance/reports/{reportId} (totals, exchange rates, confirmation) and its lines with GET /finance/reports/{reportId}/lines; confirm or submit it in the console when confirmation.nextActor is seller
DuplicationDedupe by report id
RelatedFinance and settlement
JSON
{
  "eventId": "evt_1754385262108_27f8bb715ddcb32f",
  "eventLogId": "evt_1754385262101_d1120caa82ab1a82",
  "eventType": "report.ready",
  "eventVersion": "1",
  "occurredAt": "2026-08-05T09:14:22.108Z",
  "reportId": "4c3d2e1f-0a9b-8c7d-6e5f-4a3b2c1d0e9f",
  "reportMonth": "2026-07",
  "modelType": "api",
  "currencyCode": "USD",
  "transactionCount": 1842,
  "readyAt": "2026-08-05T09:14:22.108Z"
}

payout.file_ready#

TriggerA vendor invoice you owe was paid (any rail); its reconciliation file is final
Seller actionDownload GET /finance/invoices/{invoiceId}/reconciliation (the reconciliationPath) and match it to the bank line
DuplicationDedupe by invoiceId
RelatedFinance and settlement

The file lists every balance movement the payout settles and every API sale under each movement: order reference, key id, gross, VAT, net and the three shares. Movement amounts add up to totalMinor (older name totalCents, same value) in currencyCode, the payment currency; currencyExponent is its number of minor-unit digits (2 for EUR, 0 for JPY, 3 for KWD).

JSON
{
  "eventId": "evt_1754385262108_f299b3565f82f7c7",
  "eventLogId": "evt_1754385262101_d0e780f40e39726e",
  "eventType": "payout.file_ready",
  "eventVersion": "1",
  "occurredAt": "2026-08-12T10:02:41.511Z",
  "invoiceId": "0b9a8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d",
  "invoiceNumber": "V-2026-0042",
  "settlementPackageId": "7d6c5b4a-3928-4170-a6b5-c4d3e2f1a0b9",
  "publisherCompanyId": "content-owner-co",
  "currencyCode": "EUR",
  "currencyExponent": 2,
  "totalCents": 1849250,
  "totalMinor": 1849250,
  "saleCount": 1842,
  "settledAt": "2026-08-12T10:02:41.511Z",
  "reconciliationPath": "/api/seller/v1/finance/invoices/0b9a8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d/reconciliation",
  "readyAt": "2026-08-12T10:02:42.090Z"
}

system.webhook_endpoint_disabled#

TriggerThe delivery circuit breaker auto-disabled one of your endpoints
Seller actionFix the failing receiver, then POST /webhooks/{id}/enable — buffered events flush automatically
DuplicationFires once per active → disabled transition
RelatedWebhooks — retries, buffering, circuit breaker

Delivered to your company's other endpoints; the disabled endpoint's own copy is buffered and arrives after re-enable. Paired with an in-app console notification and an email to company admins.

JSON
{
  "eventId": "evt_1754385262108_09db46598c638091",
  "eventLogId": "evt_1754385262101_7f8edac7c7596a04",
  "eventType": "system.webhook_endpoint_disabled",
  "eventVersion": "1",
  "occurredAt": "2026-08-12T02:15:00.000Z",
  "endpointId": "b7f1c2d4-5e6a-4b8c-9d0e-1f2a3b4c5d6e",
  "endpointHost": "store.example.com",
  "reason": "consecutive_delivery_failures",
  "consecutiveFailures": 10,
  "disabledAt": "2026-08-12T02:15:00.000Z"
}

system.webhook_endpoint_failing#

TriggerDeliveries to one of your endpoints failed at least 3 times in a row over at least 10 minutes
Seller actionFix the receiver; the endpoint is still active and retries continue. Check it with GET /webhooks/{id}/deliveries/{deliveryId}
DuplicationFires once per failing episode; system.webhook_endpoint_recovered ends the episode
RelatedWebhooks — early warning, circuit breaker

The early warning, about 45 hours before the circuit breaker would disable the endpoint. It is on your event log (GET /events) whether or not any endpoint can receive it, and is delivered to the endpoints that subscribe to it. Paired with an in-app console notification to company admins.

JSON
{
  "eventId": "evt_1754385262108_4c7d2e9a1b3f5e60",
  "eventLogId": "evt_1754385262101_8a1f3c5e7d9b2046",
  "eventType": "system.webhook_endpoint_failing",
  "eventVersion": "1",
  "occurredAt": "2026-08-12T02:25:00.000Z",
  "endpointId": "b7f1c2d4-5e6a-4b8c-9d0e-1f2a3b4c5d6e",
  "endpointHost": "store.example.com",
  "failingSince": "2026-08-12T02:25:00.000Z",
  "firstFailedAt": "2026-08-12T02:12:30.000Z",
  "consecutiveFailedAttempts": 4,
  "lastError": "http_503",
  "lastResponseStatus": 503
}

system.webhook_endpoint_recovered#

TriggerA failing endpoint answered 2xx again
Seller actionNone; check the delivery log for anything that failed for good meanwhile
DuplicationFires once per failing episode
RelatedWebhooks — early warning
JSON
{
  "eventId": "evt_1754385262108_7e2b9d4c6a1f3058",
  "eventLogId": "evt_1754385262101_2d6f8b0a4c9e1375",
  "eventType": "system.webhook_endpoint_recovered",
  "eventVersion": "1",
  "occurredAt": "2026-08-12T03:40:00.000Z",
  "endpointId": "b7f1c2d4-5e6a-4b8c-9d0e-1f2a3b4c5d6e",
  "endpointHost": "store.example.com",
  "failingSince": "2026-08-12T02:25:00.000Z",
  "recoveredAt": "2026-08-12T03:40:00.000Z"
}

platform.notice#

TriggerAvrix announces a change to the Seller API itself: a contract change, a deprecation, a change of the default contract date, the switch of rate limits to enforced, or planned maintenance
Seller actionRead summary and the page at url; when actionRequired is true, plan the change before effectiveAt
DuplicationOne notice has one noticeId. Each endpoint subscribed to the event receives it once (at-least-once delivery), so dedupe on noticeId when several of your endpoints subscribe
RelatedVersioning and compatibility, Changelog

Sent only to endpoints whose events include platform.notice; add it with PATCH /webhooks/{id} or when you register the endpoint. It carries no data about your company, and sandbox endpoints receive the same notices. A notice points at its changelog entry, which stays the full record.

FieldMeaning
noticeIdStable id of the notice, the same on every delivery
categoryapi_change, deprecation, contract_date, rate_limits, maintenance or other. New values may be added: treat an unknown one as other
actionRequiredtrue when an integration may have to change something before effectiveAt
title, summaryPlain text, at most 140 and 1,000 characters
effectiveAtWhen the change takes effect, or null
contractDateThe contract date the notice concerns, or null
affectsOperations (POST /orders) or event names concerned; empty when it concerns the whole API
urlPublic page with the details
publishedAtWhen Avrix published the notice
JSON
{
  "eventId": "evt_1754385262108_9b99ab33624a3af9",
  "eventLogId": "evt_1754385262101_7eb81c6e687f0887",
  "eventType": "platform.notice",
  "eventVersion": "1",
  "occurredAt": "2026-11-12T09:00:00.000Z",
  "noticeId": "contract-date-2026-12-01",
  "category": "contract_date",
  "actionRequired": false,
  "title": "Contract date 2026-12-01 is available as an opt-in pin",
  "summary": "Pin X-Avrix-Api-Version: 2026-12-01 to receive the corrected status codes and error codes listed in the changelog. Unpinned requests are not affected.",
  "effectiveAt": null,
  "contractDate": "2026-12-01",
  "affects": [],
  "url": "https://docs.avrix.io/seller-api/changelog#2026-11-12",
  "publishedAt": "2026-11-12T09:00:00.000Z"
}

api_key.created#

TriggerAn API key was created for your company, in the console or with POST /api-keys (via)
Seller actionIf you did not expect it, revoke it (DELETE /api-keys/{id}) and review who has console access
DuplicationDedupe by eventLogId
RelatedGET /api-keys, Authentication
JSON
{
  "eventId": "evt_1754385262108_c9391c7661cdd2ef",
  "eventLogId": "evt_1754385262101_2d17eb9d02159c1a",
  "eventType": "api_key.created",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "apiKeyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyName": "Storefront production",
  "environment": "production",
  "via": "console",
  "changedAt": "2026-12-01T10:00:00.101Z"
}

Key events carry the key's id, never its secret: apiKeyId, the id GET /api-keys lists. keyId is its older name, with the same value; everywhere else in the API keyId names a game key. keyName and environment are set on api_key.created and may be null on the others.


api_key.rotated#

TriggerAn API key's secret was replaced, in the console or with POST /api-keys/{id}/rotate. The key id stays the same
Seller actionMake sure the new secret reached every system that calls the API; if you did not rotate it, revoke the key
DuplicationDedupe by eventLogId
RelatedPOST /api-keys/{id}/rotate
JSON
{
  "eventId": "evt_1754385262108_3099415c9c5b0041",
  "eventLogId": "evt_1754385262101_3dfaa034d61b265c",
  "eventType": "api_key.rotated",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "apiKeyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyName": null,
  "environment": null,
  "via": "console",
  "changedAt": "2026-12-01T10:00:00.101Z"
}

api_key.revoked#

TriggerAn API key was revoked, in the console or with DELETE /api-keys/{id}. Revoking every key at once sends one event per key
Seller actionStop using the key; calls with it are refused from now on
DuplicationDedupe by eventLogId
RelatedDELETE /api-keys/{id}
JSON
{
  "eventId": "evt_1754385262108_d970c8c327d614a2",
  "eventLogId": "evt_1754385262101_00c2cd263a540e3b",
  "eventType": "api_key.revoked",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "apiKeyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyName": null,
  "environment": null,
  "via": "console",
  "changedAt": "2026-12-01T10:00:00.101Z"
}

api_key.expiring#

TriggerAn API key reaches its expiry (expiresAt) within 14 days. Sent once per expiry, only for keys meant to live longer than 14 days, never for a revoked key
Seller actionCreate a replacement key (POST /keys, or the console), move every system that calls the API to it, then revoke the old key
DuplicationDedupe by eventLogId
RelatedGET /keys (each key's expiresAt), POST /keys
JSON
{
  "eventId": "evt_1754385262108_5b0e8f1d2c3a4967",
  "eventLogId": "evt_1754385262101_7a1c2e3f4d5b6a78",
  "eventType": "api_key.expiring",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:50:00.101Z",
  "keyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyName": "Storefront production",
  "environment": "production",
  "expiresAt": "2026-12-15T09:00:00.000Z"
}

Expiry events carry the key's id, name, environment and expiry, never its secret. A key given a new expiry is announced again for the new date.


api_key.expired#

TriggerAn API key reached its expiry; calls with it are refused with 401. Sent once, within the hour after expiresAt, never for a key revoked before it expired
Seller actionStop using the key. If a system still calls with it, give that system a current key
DuplicationDedupe by eventLogId
RelatedGET /keys, Authentication
JSON
{
  "eventId": "evt_1754385262108_8e2d4c6a0b1f3957",
  "eventLogId": "evt_1754385262101_1f3e5d7c9b0a2846",
  "eventType": "api_key.expired",
  "eventVersion": "1",
  "occurredAt": "2026-12-15T09:50:00.101Z",
  "keyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyName": "Storefront production",
  "environment": "production",
  "expiresAt": "2026-12-15T09:00:00.000Z"
}

sandbox.certification_passed#

TriggerA sandbox key's certification report (GET /sandbox/certification) passed every case: the first time, and again only if it passes after a report with a failed case. Sent to the endpoints registered with that sandbox key
Seller actionTell your Avrix partner contact or support@avrix.io that the report passes. Passing does not enable production access by itself
DuplicationDedupe by eventLogId; firstPass is true only the first time the key's report passes
RelatedGET /sandbox/certification, Certification
JSON
{
  "eventId": "evt_1754385262108_3a7c9e1f5b2d4086",
  "eventLogId": "evt_1754385262101_6d8f0b2c4e1a3975",
  "eventType": "sandbox.certification_passed",
  "eventVersion": "1",
  "occurredAt": "2026-12-01T10:00:00.101Z",
  "keyId": "c4d5e6f7-0819-4a2b-8c3d-4e5f60718293",
  "keyName": "Storefront sandbox",
  "environment": "sandbox",
  "reportVersion": 1,
  "caseCount": 12,
  "firstPass": true,
  "passedAt": "2026-12-01T10:00:00.000Z"
}

The report is evaluated when it is built (GET /sandbox/certification, the console panel, or Avrix accepting your evidence), so a pass that comes from new traffic is announced the next time the report is built.


What links here

Published guides that link to this page.

Search docs

Search documentation…