Zum Inhalt springen
Sursa Developers

Ereignisse · Personen und Zugriff

api_key.expiring

API-Schlüssel läuft bald ab

Ein API-Schlüssel läuft innerhalb von 7 Tagen ab. Das Ereignis wird einmal pro Ablaufdatum gesendet.

Objekttyp
api_key
Zugestellt an
Endpunkte mit der Rolle admin

Payload

Objekt: EventApiKeyExpiring

  • idstringerforderlich

    Ereignis-ID (evt_…), auch als Header webhook-id gesendet. Verwenden Sie sie, um doppelte Zustellungen zu verwerfen.

  • typestringerforderlich

    Zulässige Werte: api_key.expiring

  • created_atstring (date-time)erforderlich

    Wann die Änderung stattgefunden hat (UTC).

  • org_idintegererforderlich
  • api_versionstringerforderlich

    Vertragsversion des Schemas von data.

  • sequenceinteger

    Laufende Nummer der Zustellung innerhalb des Endpunkts (fehlt bei einem Testereignis).

  • objectWebhookEventObjecterforderlich
  • payloadstringerforderlich

    thin bedeutet kein data: Lesen Sie das Objekt über die API.

    Zulässige Werte: fullthin

  • dataobject
    Felder
    • api_keyEventAPIKeyerforderlich
    • days_leftintegererforderlich

      Verbleibende Tage bis zum Ablauf des Schlüssels.

  • testbooleanerforderlich

    Ein Testereignis, gesendet durch POST /v1/webhooks/{webhook_id}/test.

Beispielzustellung

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

Ereignisse empfangen

Jede Zustellung ist eine POST-Anfrage mit diesem JSON-Body an Ihren Endpunkt. Prüfen Sie den Header webhook-signature (Standard Webhooks), bevor Sie dem Body vertrauen, antworten Sie innerhalb weniger Sekunden mit einem Status 2xx und erledigen Sie die Arbeit danach. Zustellungen an einen Endpunkt behalten die Reihenfolge der Ereignisse bei; eine fehlgeschlagene Zustellung wird mit wachsenden Pausen wiederholt.

Neue Ereignistypen und neue Felder können jederzeit hinzukommen: Überspringen Sie Typen und Felder, die Sie nicht kennen.

Dieselben Ereignisse stehen 30 Tage lang im Ereignis-Feed →