Elenca i tipi di evento

GET /v1/event-types · autorizzazione events:read · tutti i piani

Restituisce il catalogo eventi del cliente: ogni tipo di evento a cui un endpoint webhook può iscriversi e che Elenca eventi può restituire. Ogni tipo elenca le versioni dello schema pubblicate, dalla più vecchia alla più recente, e indica se è ad alto volume. La documentazione leggibile per ciascun tipo si trova in Eventi.

Il catalogo è uguale in ogni ambiente. I risultati sono ordinati per nome del tipo, in ordine decrescente per impostazione predefinita (order=asc per crescente), in pagine con cursore.

Richiesta

Campo Tipo Obbligatorio Descrizione
limit query no Da 1 a 100 elementi per pagina; predefinito 20.
after query no Cursore da list_metadata.after della pagina precedente.
before query no Cursore da list_metadata.before; non può essere combinato con after.
order query no desc (predefinito) oppure asc. Un cursore funziona solo con l'ordine per cui è stato emesso.

Risposta

200 OK. list_metadata.after è null nell'ultima pagina; non c'è un conteggio totale.

Campo Descrizione
type Tipo di evento, come user.created.
schema_versions Versioni dello schema pubblicate, dalla più vecchia alla più recente. Ciascuna ha schema_version e schema_id, lo JSON Schema $id di quella versione. Un endpoint webhook che non imposta event_schema_versions per il tipo riceve la prima versione (la più vecchia).
high_volume true per i tipi che non sono inclusi quando un endpoint si iscrive a tutti i tipi; scegli questi tipi per nome (per esempio 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"}
}

Errori

HTTP codice Quando
400 invalid_cursor Il cursore è malformato, appartiene a un altro ambiente o a un altro ordine di ordinamento.
422 validation_failed Un parametro della query non è valido (/limit, /order).
401 unauthenticated La credenziale è mancante, non valida o revocata.
403 insufficient_permissions La credenziale non ha events:read.
429 rate_limited È stato superato il limite di richieste; riprova dopo il periodo Retry-After.

Esempio

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