Vai al contenuto
Sursa Developers

Eventi · Persone e accesso

api_key.expiring

Chiave API in scadenza

Una chiave API scade entro 7 giorni. L’evento viene inviato una sola volta per ogni data di scadenza.

Tipo di oggetto
api_key
Consegnato a
Webhook con il ruolo admin

Payload dell’evento

Oggetto: EventApiKeyExpiring

  • idstringobbligatorio

    ID dell’evento (evt_…), inviato anche come intestazione webhook-id. Usalo per scartare le consegne duplicate.

  • typestringobbligatorio

    Valori ammessi: api_key.expiring

  • created_atstring (date-time)obbligatorio

    Momento in cui è avvenuta la modifica (UTC).

  • org_idintegerobbligatorio
  • api_versionstringobbligatorio

    Versione del contratto dello schema di data.

  • sequenceinteger

    Numero progressivo della consegna all’interno del webhook (assente per un evento di test).

  • objectWebhookEventObjectobbligatorio
  • payloadstringobbligatorio

    thin indica che non c’è data: leggi l’oggetto tramite l’API.

    Valori ammessi: fullthin

  • dataobject
    Campi
    • api_keyEventAPIKeyobbligatorio
    • days_leftintegerobbligatorio

      Giorni rimanenti prima della scadenza della chiave.

  • testbooleanobbligatorio

    Un evento di test inviato da POST /v1/webhooks/{webhook_id}/test.

Esempio di consegna

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

Ricezione degli eventi

Ogni consegna è una richiesta POST con questo corpo JSON verso il tuo webhook. Verifica l’intestazione webhook-signature (Standard Webhooks) prima di fidarti del corpo, rispondi con uno stato 2xx entro pochi secondi ed esegui il lavoro dopo. Le consegne a uno stesso webhook mantengono l’ordine degli eventi; una consegna non riuscita viene ritentata con pause sempre più lunghe.

Nuovi tipi di evento e nuovi campi possono comparire in qualsiasi momento: ignora i tipi e i campi che non conosci.

Gli stessi eventi restano nel feed degli eventi per 30 giorni →