Test a webhook subscription

Send a signed synthetic event to this subscription.

POST/webhook-subscriptions/{subscription_id}/test

Authorization

X-API-KeyAPI key · headerrequired

API key in format `sk_*`. Scoped to your partner account; server-side use only.

Path parameters

subscription_idstring<uuid>required

Header parameters

Idempotency-Keystringrequired

Unique key for safe retries. Reusing a key on the same endpoint returns the original result.

max length 255

Responses

202Synthetic event accepted for delivery.

One of:

WebhookItemIntakeCompleted

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:item.intake.completed

dataIntakeEventrequired

One item completing digitization. Identical payload whether consumed via `GET /intakes` or the `item.intake.completed` webhook.

Show properties

qidQIDrequired

Vault's canonical identifier for one physical item. It is assigned at intake and remains stable for the item's lifetime.

intake_atstring<date-time>required

manifest_idstring<uuid> | null

Manifest this intake was attributed to, if any.

manifest_line_idstring<uuid> | null

Expected-manifest line this item matched, if any.

condition_flagsstring[]required

Verification flags raised at intake (e.g. `cracked_case`, `label_mismatch`). Empty when the item verified clean.

itemItemrequired

Show properties

One of:

GradedSlabItem

active_fulfillment_idstring<uuid> | null

The fulfillment currently holding this item, if any.

categorystring

Item category.

external_refstring | null

Your identifier for this item, echoed from the manifest line when matched.

image_assetsImageAsset[]required

Per-item intake imagery for graded slabs or catalog imagery for product items.

Show properties

Array of ImageAsset

variantstringrequired

Which view of the slab this asset shows.

Allowed:frontbacklabel

urlstring<uri>required

Permanent CDN URL.

widthintegerrequired

Pixel width.

heightintegerrequired

Pixel height.

formatstringrequired

Allowed:webpjpegpng

intake_atstring<date-time>required

When the item completed intake and entered the system.

manifest_line_idstring<uuid> | null

The expected-manifest line this item matched at intake, if any.

model_3dstring<uri> | null

Reserved for future render assets and always null today so clients can keep a stable schema.

namestringrequired

Display name, clean enough to show to your end customers.

qidQIDrequired

Vault's canonical identifier for one physical item. It is assigned at intake and remains stable for the item's lifetime.

setstring | null

card_numberstring | null

skustringrequired

Warehouse SKU. Product items reference the partner catalog; graded slabs use their graded-item SKU.

statusItemStatusrequired

Custody lifecycle for one physical item. New statuses may be added compatibly within v1.

Allowed:receiveddigitizedavailablein_fulfillmentin_transitdeliveredpending_transferreleasedwithdrawn

typestringrequired

Allowed:graded_slab

updated_atstring<date-time>required

cert_numberstringrequired

Grader certification number.

gradestringrequired

graderstringrequired

Grading company.

ProductItem

active_fulfillment_idstring<uuid> | null

The fulfillment currently holding this item, if any.

categorystring

Item category.

external_refstring | null

Your identifier for this item, echoed from the manifest line when matched.

image_assetsImageAsset[]required

Per-item intake imagery for graded slabs or catalog imagery for product items.

Show properties

Array of ImageAsset

variantstringrequired

Which view of the slab this asset shows.

Allowed:frontbacklabel

urlstring<uri>required

Permanent CDN URL.

widthintegerrequired

Pixel width.

heightintegerrequired

Pixel height.

formatstringrequired

Allowed:webpjpegpng

intake_atstring<date-time>required

When the item completed intake and entered the system.

manifest_line_idstring<uuid> | null

The expected-manifest line this item matched at intake, if any.

model_3dstring<uri> | null

Reserved for future render assets and always null today so clients can keep a stable schema.

namestringrequired

Display name, clean enough to show to your end customers.

qidQIDrequired

Vault's canonical identifier for one physical item. It is assigned at intake and remains stable for the item's lifetime.

setstring | null

card_numberstring | null

skustringrequired

Warehouse SKU. Product items reference the partner catalog; graded slabs use their graded-item SKU.

statusItemStatusrequired

Custody lifecycle for one physical item. New statuses may be added compatibly within v1.

Allowed:receiveddigitizedavailablein_fulfillmentin_transitdeliveredpending_transferreleasedwithdrawn

typestringrequired

Allowed:product

updated_atstring<date-time>required

cert_numberstring | nullrequired

Allowed:null

gradestring | nullrequired

Allowed:null

graderstring | nullrequired

Allowed:null

WebhookItemStatusChanged

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:item.status.changed

dataItemrequired

Show properties

One of:

GradedSlabItem

active_fulfillment_idstring<uuid> | null

The fulfillment currently holding this item, if any.

categorystring

Item category.

external_refstring | null

Your identifier for this item, echoed from the manifest line when matched.

image_assetsImageAsset[]required

Per-item intake imagery for graded slabs or catalog imagery for product items.

Show properties

Array of ImageAsset

variantstringrequired

Which view of the slab this asset shows.

Allowed:frontbacklabel

urlstring<uri>required

Permanent CDN URL.

widthintegerrequired

Pixel width.

heightintegerrequired

Pixel height.

formatstringrequired

Allowed:webpjpegpng

intake_atstring<date-time>required

When the item completed intake and entered the system.

manifest_line_idstring<uuid> | null

The expected-manifest line this item matched at intake, if any.

model_3dstring<uri> | null

Reserved for future render assets and always null today so clients can keep a stable schema.

namestringrequired

Display name, clean enough to show to your end customers.

qidQIDrequired

Vault's canonical identifier for one physical item. It is assigned at intake and remains stable for the item's lifetime.

setstring | null

card_numberstring | null

skustringrequired

Warehouse SKU. Product items reference the partner catalog; graded slabs use their graded-item SKU.

statusItemStatusrequired

Custody lifecycle for one physical item. New statuses may be added compatibly within v1.

Allowed:receiveddigitizedavailablein_fulfillmentin_transitdeliveredpending_transferreleasedwithdrawn

typestringrequired

Allowed:graded_slab

updated_atstring<date-time>required

cert_numberstringrequired

Grader certification number.

gradestringrequired

graderstringrequired

Grading company.

ProductItem

active_fulfillment_idstring<uuid> | null

The fulfillment currently holding this item, if any.

categorystring

Item category.

external_refstring | null

Your identifier for this item, echoed from the manifest line when matched.

image_assetsImageAsset[]required

Per-item intake imagery for graded slabs or catalog imagery for product items.

Show properties

Array of ImageAsset

variantstringrequired

Which view of the slab this asset shows.

Allowed:frontbacklabel

urlstring<uri>required

Permanent CDN URL.

widthintegerrequired

Pixel width.

heightintegerrequired

Pixel height.

formatstringrequired

Allowed:webpjpegpng

intake_atstring<date-time>required

When the item completed intake and entered the system.

manifest_line_idstring<uuid> | null

The expected-manifest line this item matched at intake, if any.

model_3dstring<uri> | null

Reserved for future render assets and always null today so clients can keep a stable schema.

namestringrequired

Display name, clean enough to show to your end customers.

qidQIDrequired

Vault's canonical identifier for one physical item. It is assigned at intake and remains stable for the item's lifetime.

setstring | null

card_numberstring | null

skustringrequired

Warehouse SKU. Product items reference the partner catalog; graded slabs use their graded-item SKU.

statusItemStatusrequired

Custody lifecycle for one physical item. New statuses may be added compatibly within v1.

Allowed:receiveddigitizedavailablein_fulfillmentin_transitdeliveredpending_transferreleasedwithdrawn

typestringrequired

Allowed:product

updated_atstring<date-time>required

cert_numberstring | nullrequired

Allowed:null

gradestring | nullrequired

Allowed:null

graderstring | nullrequired

Allowed:null

WebhookFulfillmentStatusChanged

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:fulfillment.status.changed

dataFulfillmentrequired

Everything shipping-related you would mirror to your customer. Carrier, service, and tracking populate once the label is generated.

Show properties

idstring<uuid>required

qidsQID[]required

statusFulfillmentStatusrequired

Fulfillment lifecycle. Returned means custody has resumed and the item will repeat intake.

Allowed:pendingprocessingshippeddeliveredcancelledexceptionreturned

processing_stageProcessingStage | null

Warehouse sub-stage while status is processing. It may be null when granular telemetry is unavailable; status is always authoritative.

Allowed:pickedpackedverifiedlabeledqueued_for_carrier

shipping_addressShippingAddress | any

Show properties

Any of:

ShippingAddress

recipient_namestringrequired

streetstringrequired

street_2string | null

citystringrequired

statestringrequired

zipstringrequired

countrystringrequired

any

any

carrierstring | null

Carrier code once the label exists.

servicestring | null

Service code once the label exists.

tracking_numberstring | null

tracking_urlstring<uri> | null

issueFulfillmentIssue | any

Show properties

Any of:

FulfillmentIssue

codestringrequired

Machine-readable issue type.

messagestringrequired

occurred_atstring<date-time>required

any

any

external_refstring | null

created_atstring<date-time>required

updated_atstring<date-time>required

typeFulfillmentTyperequired

Allowed:standardwithdrawal

special_instructionsstring | null

deliver_bystring<date> | null

verified_address_idstring<uuid> | null

WebhookFulfillmentIssueRaised

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:fulfillment.issue.raised

dataFulfillmentrequired

Everything shipping-related you would mirror to your customer. Carrier, service, and tracking populate once the label is generated.

Show properties

idstring<uuid>required

qidsQID[]required

statusFulfillmentStatusrequired

Fulfillment lifecycle. Returned means custody has resumed and the item will repeat intake.

Allowed:pendingprocessingshippeddeliveredcancelledexceptionreturned

processing_stageProcessingStage | null

Warehouse sub-stage while status is processing. It may be null when granular telemetry is unavailable; status is always authoritative.

Allowed:pickedpackedverifiedlabeledqueued_for_carrier

shipping_addressShippingAddress | any

Show properties

Any of:

ShippingAddress

recipient_namestringrequired

streetstringrequired

street_2string | null

citystringrequired

statestringrequired

zipstringrequired

countrystringrequired

any

any

carrierstring | null

Carrier code once the label exists.

servicestring | null

Service code once the label exists.

tracking_numberstring | null

tracking_urlstring<uri> | null

issueFulfillmentIssue | any

Show properties

Any of:

FulfillmentIssue

codestringrequired

Machine-readable issue type.

messagestringrequired

occurred_atstring<date-time>required

any

any

external_refstring | null

created_atstring<date-time>required

updated_atstring<date-time>required

typeFulfillmentTyperequired

Allowed:standardwithdrawal

special_instructionsstring | null

deliver_bystring<date> | null

verified_address_idstring<uuid> | null

WebhookManifestReconciliationCompleted

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:manifest.reconciliation.completed

dataManifestReconciliationCompletedDatarequired

Final reconciliation totals; fetch the report endpoint for per-line detail.

Show properties

manifest_idstring<uuid>required

generated_atstring<date-time>required

totalsobjectrequired

Show properties

expectedintegerrequired

matchedintegerrequired

missingintegerrequired

unexpectedintegerrequired

condition_mismatchintegerrequired

WebhookTransferRequested

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:transfer.requested

dataTransferrequired

Show properties

created_atstring<date-time>required

external_refstring | null

idstring<uuid>required

qidsQID[]required

statusTransferStatusrequired

Allowed:requestedcompleteddeclinedcancelled

typeTransferTyperequired

Allowed:sell_back

updated_atstring<date-time>required

WebhookTransferCompleted

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:transfer.completed

dataTransferrequired

Show properties

created_atstring<date-time>required

external_refstring | null

idstring<uuid>required

qidsQID[]required

statusTransferStatusrequired

Allowed:requestedcompleteddeclinedcancelled

typeTransferTyperequired

Allowed:sell_back

updated_atstring<date-time>required

WebhookTransferDeclined

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:transfer.declined

dataTransferrequired

Show properties

created_atstring<date-time>required

external_refstring | null

idstring<uuid>required

qidsQID[]required

statusTransferStatusrequired

Allowed:requestedcompleteddeclinedcancelled

typeTransferTyperequired

Allowed:sell_back

updated_atstring<date-time>required

WebhookTransferCancelled

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:transfer.cancelled

dataTransferrequired

Show properties

created_atstring<date-time>required

external_refstring | null

idstring<uuid>required

qidsQID[]required

statusTransferStatusrequired

Allowed:requestedcompleteddeclinedcancelled

typeTransferTyperequired

Allowed:sell_back

updated_atstring<date-time>required

WebhookFulfillmentReturned

idstring<uuid>required

Unique event ID — use for deduplication.

created_atstring<date-time>required

typestringrequired

Allowed:fulfillment.returned

dataFulfillmentrequired

Everything shipping-related you would mirror to your customer. Carrier, service, and tracking populate once the label is generated.

Show properties

idstring<uuid>required

qidsQID[]required

statusFulfillmentStatusrequired

Fulfillment lifecycle. Returned means custody has resumed and the item will repeat intake.

Allowed:pendingprocessingshippeddeliveredcancelledexceptionreturned

processing_stageProcessingStage | null

Warehouse sub-stage while status is processing. It may be null when granular telemetry is unavailable; status is always authoritative.

Allowed:pickedpackedverifiedlabeledqueued_for_carrier

shipping_addressShippingAddress | any

Show properties

Any of:

ShippingAddress

recipient_namestringrequired

streetstringrequired

street_2string | null

citystringrequired

statestringrequired

zipstringrequired

countrystringrequired

any

any

carrierstring | null

Carrier code once the label exists.

servicestring | null

Service code once the label exists.

tracking_numberstring | null

tracking_urlstring<uri> | null

issueFulfillmentIssue | any

Show properties

Any of:

FulfillmentIssue

codestringrequired

Machine-readable issue type.

messagestringrequired

occurred_atstring<date-time>required

any

any

external_refstring | null

created_atstring<date-time>required

updated_atstring<date-time>required

typeFulfillmentTyperequired

Allowed:standardwithdrawal

special_instructionsstring | null

deliver_bystring<date> | null

verified_address_idstring<uuid> | null

400Validation failed.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

401Missing, invalid, expired, or environment-mismatched API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

404No such resource exists for this partner and environment.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

429Rate limit exceeded for this API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

subscription_idpath*Idempotency-Keyheader*Unique key for safe retries. Reusing a key on the same endpoint returns the original result.

Request

curl -X POST "https://api.vault.stashtab.gg/v1/webhook-subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/test" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Idempotency-Key: string"

const response = await fetch("https://api.vault.stashtab.gg/v1/webhook-subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/test", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Idempotency-Key": "string"
  }
});

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "type": "item.intake.completed",
  "data": {
    "qid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "intake_at": "2019-08-24T14:15:22Z",
    "manifest_id": "82825e8e-31fc-47d5-83ce-cd926068341e",
    "manifest_line_id": "e1bcc1ed-284d-4866-b8d7-5633b41d43ea",
    "condition_flags": [
      "string"
    ],
    "item": {
      "active_fulfillment_id": "bcb367cb-b94e-4e20-973d-e3de4f574083",
      "category": "sports-card",
      "external_ref": "string",
      "image_assets": [
        {
          "variant": "front",
          "url": "http://example.com",
          "width": 0,
          "height": 0,
          "format": "webp"
        }
      ],
      "intake_at": "2019-08-24T14:15:22Z",
      "manifest_line_id": "e1bcc1ed-284d-4866-b8d7-5633b41d43ea",
      "model_3d": "http://example.com",
      "name": "2018 Panini Prizm Luka Doncic",
      "qid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "set": "2018-19 Panini Prizm",
      "card_number": "280",
      "sku": "string",
      "status": "available",
      "type": "graded_slab",
      "updated_at": "2019-08-24T14:15:22Z",
      "cert_number": "string",
      "grade": "string",
      "grader": "string"
    }
  }
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}