Anar al contingut
Sursa Developers

Esdeveniments · Persones i accés

api_key.revoked

Clau d’API revocada

S’ha revocat una clau d’API i deixa de funcionar.

Tipus d’objecte
api_key
Es lliura a
Webhooks amb el rol admin

Càrrega útil

Objecte: EventApiKeyRevoked

  • idstringobligatori

    ID de l’esdeveniment (evt_…), que també s’envia com a capçalera webhook-id. Feu-lo servir per descartar els lliuraments duplicats.

  • typestringobligatori

    Valors permesos: api_key.revoked

  • created_atstring (date-time)obligatori

    Moment en què es va produir el canvi (UTC).

  • org_idintegerobligatori
  • api_versionstringobligatori

    Versió del contracte de l’esquema de data.

  • sequenceinteger

    Número de seqüència del lliurament dins del webhook (no hi és en un esdeveniment de prova).

  • objectWebhookEventObjectobligatori
  • payloadstringobligatori

    thin vol dir sense data: llegiu l’objecte a través de l’API.

    Valors permesos: fullthin

  • dataobject
    Camps
    • api_keyEventAPIKeyobligatori
    • actor_idinteger | nullobligatori

      Usuari que ha fet l’acció; null per a una clau d’API de l’organització o la mateixa plataforma.

    • reasonstring

      Per què s’ha revocat: manual o user_offboarded.

  • testbooleanobligatori

    Esdeveniment de prova enviat per POST /v1/webhooks/{webhook_id}/test.

Exemple de lliurament

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "api_key.revoked",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "api_key",
    "id": "14"
  },
  "payload": "full",
  "data": {
    "api_key": {
      "id": 14,
      "name": "CRM sync",
      "prefix": "kb_3f9a",
      "kind": "org",
      "role": "editor",
      "scopes": [
        "cards:read",
        "cards:write"
      ],
      "expires_at": "2026-10-31T00:00:00Z"
    },
    "actor_id": 7,
    "reason": "manual"
  },
  "test": false
}

Recepció d’esdeveniments

Cada lliurament és una sol·licitud POST amb aquest cos JSON a l’URL del vostre webhook. Verifiqueu la capçalera webhook-signature (Standard Webhooks) abans de confiar en el cos, responeu amb un estat 2xx en pocs segons i feu la feina després. Els lliuraments a un mateix webhook mantenen l’ordre dels esdeveniments; un lliurament fallit es reintenta amb pauses cada vegada més llargues.

En qualsevol moment poden aparèixer tipus d’esdeveniment i camps nous: ometeu els tipus i els camps que no conegueu.

Els mateixos esdeveniments són al canal d’esdeveniments durant 30 dies →