Pereiti prie turinio
Sursa Developers

Įvykiai · Žmonės ir prieiga

api_key.revoked

API raktas atšauktas

API raktas atšauktas ir nustoja veikti.

Objekto tipas
api_key
Kam pristatoma
Galiniams taškams su vaidmeniu admin

Turinys

Objektas: EventApiKeyRevoked

  • idstringprivalomas

    Įvykio ID (evt_…), taip pat siunčiamas antraštėje webhook-id. Naudokite jį pristatymų dublikatams atmesti.

  • typestringprivalomas

    Leidžiamos reikšmės: api_key.revoked

  • created_atstring (date-time)privalomas

    Kada įvyko pakeitimas (UTC).

  • org_idintegerprivalomas
  • api_versionstringprivalomas

    data schemos kontrakto versija.

  • sequenceinteger

    Pristatymo eilės numeris galiniame taške (bandomajam įvykiui jo nėra).

  • objectWebhookEventObjectprivalomas
  • payloadstringprivalomas

    thin reiškia, kad data nėra: objektą perskaitykite per API.

    Leidžiamos reikšmės: fullthin

  • dataobject
    Laukai
    • api_keyEventAPIKeyprivalomas
    • actor_idinteger | nullprivalomas

      Naudotojas, atlikęs veiksmą; null organizacijos API raktui arba pačiai platformai.

    • reasonstring

      Kodėl atšaukta: manual arba user_offboarded.

  • testbooleanprivalomas

    Bandomasis įvykis, išsiųstas per POST /v1/webhooks/{webhook_id}/test.

Pristatymo pavyzdys

{
  "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
}

Įvykių gavimas

Kiekvienas pristatymas – POST užklausa su šiuo JSON turiniu jūsų galiniam taškui. Pirmiausia patikrinkite antraštės webhook-signature parašą (Standard Webhooks) ir tik tada pasitikėkite turiniu, per kelias sekundes atsakykite 2xx būsena, o darbą atlikite vėliau. Pristatymai vienam galiniam taškui išlaiko įvykių tvarką; nepavykęs pristatymas kartojamas vis ilgesnėmis pauzėmis.

Nauji įvykių tipai ir nauji laukai gali atsirasti bet kada: nežinomus tipus ir laukus praleiskite.

Tie patys įvykiai 30 dienų pasiekiami įvykių juostoje →