customer.archived

The club archived a customer. data.object.archived_at is set.

Scope: the webhook endpoint’s scopes must include customers:read. Missed a delivery? The same signal is available from GET /v1/signals.

Header Parameters

svix-id*string

The delivery id — stable across retries of the same signal. Not the same string as the body’s id, but one-to-one with it, so either works as a dedupe key.

svix-timestamp*string

When this attempt was sent, in Unix seconds.

svix-signature*string

Signature over the id, timestamp and raw body, made with your endpoint’s secret. Verify it with any Standard Webhooks library before trusting the payload.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Opaque sig_-prefixed id. Identifies WHAT HAPPENED, and never changes.

object*string

Value in"signal"

type*string

Value in"customer.archived"

created*string

When the signal was emitted (ISO-8601, UTC) — not when it was delivered.

Formatdate-time

sequence*integer

Per-club counter. A staleness key, not an ordering guarantee. Use it to compare two signals about the SAME resource: the lower one is older and may be discarded. Gaps are normal and carry no meaning — a webhook endpoint receives only the types it subscribes to, and GET /v1/signals returns only the signals your key’s scopes cover — so never infer loss from a gap, wait for a missing number, or compare sequence across clubs.

api_version*string

The payload contract version. v1 today.

data*

data.object is the matching /v1 resource — the same fields carrying the same values that endpoint returns. Compare it as parsed JSON: key order is not part of the contract.

Response Body

Example Requests

POST/customer.archived

Header Parameters

Request Body

Response Body

200

Bodyapplication/json

Header