Documentation/api_key.revoked

`api_key.revoked`

A signed Boundry platform event. Its payload remains pinned to the API version configured for the receiving endpoint.

api_key.revoked

A project API key was revoked.

Channel: api_key

Payload schema

FieldTypeDescription

api_versionrequiredstring

API version pinned to the webhook endpoint. Values: "2026-08-14". Default: "2026-08-14".

created_atrequiredstring (date-time)

Timestamp when Boundry created the event. Example: "2026-08-14T12:00:00.000Z".

datarequiredobject

Event resource wrapper. Example: {"object":{"created_at":"2026-08-14T12:00:00.000Z","id":"key_01j0example","name":"Production app"}}.

objectrequiredobject

Event resource. Example: {"created_at":"2026-08-14T12:00:00.000Z","id":"key_01j0example","name":"Production app"}.

created_atrequiredstring (date-time)

Timestamp when the key was created. Example: "2026-08-14T12:00:00.000Z".

idrequiredstring

API key identifier. Example: "msg_01j0example".

namerequiredstring

Human-readable API key name. Example: "Production app".

idrequiredstring

Stable event identifier.

livemoderequiredboolean

Whether the event originated in live mode.

objectrequiredstring

Resource type discriminator. Values: "event".

project_idrequiredstring

Owning project identifier. Example: "msg_01j0example".

typerequiredstring

Webhook event type. Values: "api_key.revoked".

Sample body

api_key.revoked event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "created_at": "2026-08-14T12:00:00.000Z",
      "id": "key_01j0example",
      "name": "Production app"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "api_key.revoked"
}

Verify signed webhook deliveries →