delivery.archived

Sent to the webhook endpoints subscribed to delivery.archived in event_types. The resource type of this event, used as the key of resource_filters, is delivery.

Example body

{
  "id": "evt_01J8Z3TESTE",
  "type": "delivery.archived",
  "version": 1,
  "occurred_at": "2026-09-29T12:00:00Z",
  "data": {
    "id": "dlv_42",
    "status": "archived"
  },
  "delivery_id": "whd_01J8Z3TESTE",
  "attempt": 1
}

This event has nothing to expand: with payload_detail set to masked or full, expanded is an empty object.

Fields

FieldTypeRequiredDescription
idstringyesID of the event, prefixed with evt_, as in GET /events/{event_id}. Every delivery and retry of the same event has the same ID.
typestringyesAlways delivery.archived.
versionintegeryesAlways 1. Version of the format of data for this event type.
occurred_atstringyesWhen the event occurred, in UTC.
dataobjectyesData of the event, in the format of its version. People are identified only by ID. The only free text is the note written by whoever operates the account (reason in certificate.revoked and diamond_membership.stage_changed), sent as written.
data.idstringyesPublic ID of the delivery, prefixed with dlv_.
data.statusstringyesAlways archived. Status of the delivery. Always archived.
expandedobjectnoPresent only when the payload_detail of the endpoint is masked or full. Contains the resources the event refers to, in the same format as the API returns them, as they were when the delivery was created: a retry sends the same objects. A key is null when the resource no longer exists. In masked, personal data is masked by the rules described in payload_detail of POST /webhooks (re**@g**.com, Renan C** P**), and free text written by users is replaced with [redacted]; a masked value keeps the type of the field, but may not match its format (a masked email is not a valid address). Masked personal data is still personal data. In full, values are sent as stored. This event type refers to no resource that can be expanded, so the object is always empty.
delivery_idstringyesID of this delivery, prefixed with whd_, as in GET /webhooks/{webhook_id}/deliveries/{webhook_delivery_id}. Every retry of the delivery has the same ID.
attemptintegeryesNumber of this attempt of the delivery, starting at 1.

Your endpoint answers with any 2xx status to confirm the delivery. See Deliveries and retries.

On this page