Salt la conținut
Sursa Developers

Evenimente · Persoane și acces

api_key.expiring

Cheie API aproape de expirare

O cheie API expiră în cel mult 7 zile. Evenimentul este trimis o singură dată pentru fiecare dată de expirare.

Tipul obiectului
api_key
Livrat către
Webhookurile cu rolul admin

Conținut

Obiect: EventApiKeyExpiring

  • idstringobligatoriu

    ID-ul evenimentului (evt_…), trimis și ca antet webhook-id. Folosiți-l pentru a elimina livrările duplicate.

  • typestringobligatoriu

    Valori permise: api_key.expiring

  • created_atstring (date-time)obligatoriu

    Momentul în care a avut loc modificarea (UTC).

  • org_idintegerobligatoriu
  • api_versionstringobligatoriu

    Versiunea contractului schemei data.

  • sequenceinteger

    Numărul de ordine al livrării în cadrul webhookului (lipsește pentru un eveniment de test).

  • objectWebhookEventObjectobligatoriu
  • payloadstringobligatoriu

    thin înseamnă fără data: citiți obiectul prin API.

    Valori permise: fullthin

  • dataobject
    Câmpuri
    • api_keyEventAPIKeyobligatoriu
    • days_leftintegerobligatoriu

      Zilele rămase până la expirarea cheii.

  • testbooleanobligatoriu

    Un eveniment de test trimis de POST /v1/webhooks/{webhook_id}/test.

Exemplu de livrare

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "api_key.expiring",
  "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"
    },
    "days_left": 6
  },
  "test": false
}

Primirea evenimentelor

Fiecare livrare este o cerere POST cu acest corp JSON către webhook. Verificați antetul webhook-signature (Standard Webhooks) înainte de a avea încredere în corp, răspundeți cu un status 2xx în câteva secunde și faceți prelucrarea după aceea. Livrările către un webhook păstrează ordinea evenimentelor; o livrare eșuată este reîncercată cu pauze din ce în ce mai lungi.

Pot apărea oricând tipuri de evenimente și câmpuri noi: ignorați tipurile și câmpurile pe care nu le cunoașteți.

Aceleași evenimente se află în fluxul de evenimente timp de 30 de zile →