Olay türlerini listeleyin

GET /v1/event-types · izin events:read · tüm planlar

Müşteri olay kataloğunu döndürür: bir webhook uç noktasının abone olabileceği ve Olayları listele isteğinin döndürebileceği her olay türü. Her tür, yayımlanmış şema sürümlerini en eskiden en yeniye doğru listeler ve yüksek hacimli olup olmadığını belirtir. Her tür için insan tarafından okunabilir başvuru Olaylar altındadır.

Katalog tüm ortamlarda aynıdır. Sonuçlar varsayılan olarak tür adına göre azalan sırada (artan için order=asc) imleç sayfalarında sıralanır.

İstek

Alan Tür Zorunlu Açıklama
limit query hayır Sayfa başına 1–100 öğe; varsayılan 20.
after query hayır Önceki sayfanın list_metadata.after alanından alınan imleç.
before query hayır list_metadata.before değerinden alınan imleç; after ile birlikte kullanılamaz.
order query hayır desc (varsayılan) veya asc. İmleç yalnızca üretildiği sıralamayla çalışır.

Yanıt

200 OK. Son sayfada list_metadata.after null olur; toplam sayı yoktur.

Alan Açıklama
type Olay türü, örneğin user.created.
schema_versions Yayımlanmış şema sürümleri, en eskiden en yeniye. Her birinde schema_version ve schema_id bulunur; bu, söz konusu sürümün JSON Şeması $id'dir. Bir türe event_schema_versions değerini ayarlamayan webhook uç noktası ilk (en eski) sürümü alır.
high_volume true: tüm türlere abone olunduğunda dahil edilmeyen türler; adlarıyla seçin (örneğin 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"}
}

Hatalar

HTTP code Ne zaman
400 invalid_cursor İmleç hatalı biçimde, başka bir ortama veya başka bir sıralamaya ait.
422 validation_failed Bir sorgu parametresi geçersiz (/limit, /order).
401 unauthenticated Kimlik bilgisi eksik, geçersiz veya iptal edilmiş.
403 insufficient_permissions Kimlik bilgisinde events:read yok.
429 rate_limited Hız sınırı aşıldı; Retry-After süresinden sonra yeniden deneyin.

Örnek

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