Přejít na obsah
Sursa Developers

Události · Lidé a přístup

api_key.revoked

Klíč API odvolán

Klíč API byl odvolán a přestává fungovat.

Typ objektu
api_key
Komu se doručuje
Webhookům s rolí administrátora

Obsah události

Objekt: EventApiKeyRevoked

  • idstringpovinné

    ID události (evt_…), posílá se také jako hlavička webhook-id. Podle něj zahazujte duplicitní doručení.

  • typestringpovinné

    Povolené hodnoty: api_key.revoked

  • created_atstring (date-time)povinné

    Kdy ke změně došlo (UTC).

  • org_idintegerpovinné
  • api_versionstringpovinné

    Verze kontraktu schématu data.

  • sequenceinteger

    Pořadové číslo doručení v rámci webhooku (u testovací události chybí).

  • objectWebhookEventObjectpovinné
  • payloadstringpovinné

    thin znamená bez data: objekt si přečtěte přes API.

    Povolené hodnoty: fullthin

  • dataobject
    Pole
    • api_keyEventAPIKeypovinné
    • actor_idinteger | nullpovinné

      Uživatel, který akci provedl; null u klíče API organizace nebo samotné platformy.

    • reasonstring

      Proč byl odvolán: manual nebo user_offboarded.

  • testbooleanpovinné

    Testovací událost odeslaná pomocí POST /v1/webhooks/{webhook_id}/test.

Ukázka doručení

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

Příjem událostí

Každé doručení je požadavek POST s tímto tělem JSON na adresu vašeho příjemce. Než tělu začnete důvěřovat, ověřte hlavičku webhook-signature (Standard Webhooks), do několika sekund odpovězte stavovým kódem 2xx a samotnou práci udělejte až potom. Doručení na jeden webhook zachovávají pořadí událostí; neúspěšné doručení se opakuje s rostoucími pauzami.

Nové typy událostí a nová pole se mohou objevit kdykoli: typy a pole, které neznáte, přeskočte.

Stejné události najdete 30 dní v kanálu událostí →