Ereignistypen auflisten

GET /v1/event-types · Berechtigung events:read · alle Tarife

Gibt den Ereigniskatalog des Kunden zurück: jeden Ereignistyp, den ein Webhook-Endpunkt abonnieren kann und den Ereignisse auflisten zurückgeben kann. Jeder Typ listet seine veröffentlichten Schema-Versionen, die älteste zuerst, und ob er ein hohes Volumen hat. Die für Menschen lesbare Referenz zu jedem Typ finden Sie unter Ereignisse.

Der Katalog ist in jeder Umgebung gleich. Die Ergebnisse werden nach Typname sortiert, standardmäßig absteigend (order=asc für aufsteigend), in Cursor-Seiten.

Anfrage

Feld Typ Pflicht Beschreibung
limit query nein 1–100 Einträge pro Seite; Standard 20.
after query nein Cursor aus list_metadata.after der vorherigen Seite.
before query nein Cursor aus list_metadata.before; kann nicht mit after kombiniert werden.
order query nein desc (Standard) oder asc. Ein Cursor funktioniert nur mit der Reihenfolge, für die er ausgestellt wurde.

Antwort

200 OK. list_metadata.after ist null auf der letzten Seite; es gibt keine Gesamtanzahl.

Feld Beschreibung
type Ereignistyp, z. B. user.created.
schema_versions Veröffentlichte Schema-Versionen, die älteste zuerst. Jede hat schema_version und schema_id, das JSON-Schema $id dieser Version. Ein Webhook-Endpunkt, der event_schema_versions für den Typ nicht setzt, erhält die erste (älteste) Version.
high_volume true für Typen, die nicht enthalten sind, wenn ein Endpunkt alle Typen abonniert; wählen Sie sie über den Namen aus (z. B. authentication.succeeded). 
{
  "data": [
    {
      "type": "user.created",
      "schema_versions": [
        {"schema_version": 1, "schema_id": "https://docs.keenauth.com/events/user.created.v1.json"}
      ],
      "high_volume": false
    }
  ],
  "list_metadata": {"before": null, "after": "AQAMdXNlci5jcmVhdGVk"}
}

Fehler

HTTP Code Wann
400 invalid_cursor Der Cursor ist fehlerhaft, gehört zu einer anderen Umgebung oder einer anderen Sortierreihenfolge.
422 validation_failed Ein Abfrageparameter ist ungültig (/limit, /order).
401 unauthenticated Die Anmeldedaten fehlen, sind ungültig oder widerrufen.
403 insufficient_permissions Den Anmeldedaten fehlt events:read.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie die Anfrage nach dem Zeitraum Retry-After.

Beispiel

curl "https://api.eu.keenauth.com/v1/event-types?order=asc&limit=100" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

CLI: keenauth event-types list --order asc --limit 100