customer.archived
Triggered when a customer is archived.
X-Clocknext-Signature*stringt=<unix seconds>,v1=<hex HMAC-SHA256> — the HMAC of ${t}.${rawBody} keyed with the endpoint's signing secret. See Verify the signature.
X-Clocknext-Event-Id*stringThe event's id — the same as id in the body, and the same on every retry.
X-Clocknext-Event-Type*stringThe event name — the same as event_type in the body.
application/json- body
id*stringevt_ + 32 hex characters. Unique per event, and the same on every retry of it — use it to skip duplicates.
event_type*stringAlways customer.archived.
triggered_at*stringWhen the event was triggered (ISO 8601).
date-timedata*The customer, as it is after the change.
Answer any 2xx within 5 seconds; the body is ignored. Anything else counts as failed and is retried.
{ "id": "evt_464b5e9a90ca8a093cf004028991aa98", "event_type": "customer.archived", "triggered_at": "2026-10-09T16:40:02.118Z", "data": { "customer": { "id": "cus_abc123", "name": "Acme Corp", "external_id": "acme-42", "email": "billing@acme.com", "currency_code": "inr", "status": "ARCHIVED", "created_at": "2026-10-01T08:00:00.000Z" } }}{ "X-Clocknext-Signature": "t=1791367200,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd", "X-Clocknext-Event-Id": "evt_464b5e9a90ca8a093cf004028991aa98", "X-Clocknext-Event-Type": "customer.archived"}Types
Every object type on this page, with its fields.
CustomerArchivedEvent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | evt_ + 32 hex characters. Unique per event, and the same on every retry of it — use it to skip duplicates. |
event_type | string | yes | Always customer.archived. |
triggered_at | string | yes | When the event was triggered (ISO 8601). |
data | CustomerEventData | yes | The customer, as it is after the change. |
CustomerEventData
The data object of a customer.created, customer.archived or customer.restored event: the customer, as it is after the change.
| Field | Type | Required | Description |
|---|---|---|---|
customer | WebhookCustomerDetails | yes | The customer the event is about, as it is after the change. |
WebhookCustomerDetails
The customer the event is about, as it is after the change.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The customer's Clocknext id. |
name | string | yes | The customer's name. |
external_id | string | null | yes | Your own id for the customer. Null when none is set. |
email | string | null | yes | The customer's email. Null when none is set. |
currency_code | string | yes | The customer's currency, lowercase (ISO 4217) — what they pay in at checkout. |
status | "ACTIVE" | "ARCHIVED" | yes | ARCHIVED once the customer is archived, else ACTIVE. |
created_at | string | yes | When the customer was added (ISO 8601). |