Przejdź do treści
Sursa Developers

Zdarzenia · Osoby i dostęp

api_key.expiring

Zbliża się wygaśnięcie klucza API

Klucz API wygasa w ciągu 7 dni. Zdarzenie jest wysyłane raz dla każdej daty wygaśnięcia.

Typ obiektu
api_key
Odbiorcy
Webhooki z rolą administratora

Treść zdarzenia

Obiekt: EventApiKeyExpiring

  • idstringwymagane

    ID zdarzenia (evt_…), wysyłany także jako nagłówek webhook-id. Używaj go do odrzucania zduplikowanych dostarczeń.

  • typestringwymagane

    Dozwolone wartości: api_key.expiring

  • created_atstring (date-time)wymagane

    Kiedy nastąpiła zmiana (UTC).

  • org_idintegerwymagane
  • api_versionstringwymagane

    Wersja kontraktu schematu data.

  • sequenceinteger

    Numer kolejny dostarczenia w obrębie webhooka (brak dla zdarzenia testowego).

  • objectWebhookEventObjectwymagane
  • payloadstringwymagane

    thin oznacza brak data: odczytaj obiekt przez API.

    Dozwolone wartości: fullthin

  • dataobject
    Pola
    • api_keyEventAPIKeywymagane
    • days_leftintegerwymagane

      Dni pozostałe do wygaśnięcia klucza.

  • testbooleanwymagane

    Zdarzenie testowe wysłane przez POST /v1/webhooks/{webhook_id}/test.

Przykładowe dostarczenie

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

Odbieranie zdarzeń

Każde dostarczenie to żądanie POST z tą treścią JSON wysyłane na adres odbiorcy Twojego webhooka. Zanim zaufasz treści, zweryfikuj nagłówek webhook-signature (Standard Webhooks), odpowiedz statusem 2xx w ciągu kilku sekund, a właściwą pracę wykonaj później. Dostarczenia do jednego webhooka zachowują kolejność zdarzeń; nieudane dostarczenie jest ponawiane z coraz dłuższymi przerwami.

Nowe typy zdarzeń i nowe pola mogą pojawić się w każdej chwili: pomijaj typy i pola, których nie znasz.

Te same zdarzenia są dostępne w kanale zdarzeń przez 30 dni →