이벤트 유형 목록 조회

GET /v1/event-types · 권한 events:read · 모든 요금제

고객 이벤트 카탈로그를 반환합니다. 카탈로그에는 웹훅 엔드포인트가 구독할 수 있고 이벤트 목록 조회가 반환할 수 있는 모든 이벤트 유형이 포함됩니다. 각 유형에는 게시된 스키마 버전이 가장 오래된 순으로 나열되며, 고볼륨 여부도 표시됩니다. 각 유형의 사람이 읽을 수 있는 참조 문서는 이벤트에서 확인할 수 있습니다.

카탈로그는 모든 환경에서 동일합니다. 결과는 기본적으로 유형 이름의 내림차순으로 정렬되며(오름차순은 order=asc), 커서 페이지 단위로 반환됩니다.

요청

필드 유형 필수 여부 설명
limit query 아니요 페이지당 1–100개 항목; 기본값 20.
after query 아니요 이전 페이지의 list_metadata.after에서 받은 커서.
before query 아니요 list_metadata.before에서 받은 커서; after와 함께 사용할 수 없습니다.
order query 아니요 desc(기본값) 또는 asc. 커서는 발급된 정렬 순서에서만 작동합니다.

응답

200 OK. 마지막 페이지에서 list_metadata.after은 null이며, 전체 개수는 제공되지 않습니다.

필드 설명
type 이벤트 유형(예: user.created).
schema_versions 게시된 스키마 버전을 가장 오래된 순으로 나열합니다. 각 버전에는 schema_version와 schema_id이 있으며, 이는 해당 버전의 JSON Schema $id입니다. 해당 유형에 대해 event_schema_versions를 설정하지 않은 웹훅 엔드포인트는 첫 번째(가장 오래된) 버전을 받습니다.
high_volume true 유형은 엔드포인트가 모든 유형을 구독할 때 포함되지 않습니다. 이름으로 직접 선택하십시오(예: 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"}
}

오류

HTTP code 발생 시점
400 invalid_cursor 커서 형식이 잘못되었거나, 다른 환경 또는 다른 정렬 순서에 속합니다.
422 validation_failed 쿼리 매개변수가 잘못되었습니다(/limit, /order).
401 unauthenticated 자격 증명이 없거나, 잘못되었거나, 폐기되었습니다.
403 insufficient_permissions 자격 증명에 events:read 권한이 없습니다.
429 rate_limited 요청 한도를 초과했습니다. Retry-After 기간이 지난 후 다시 시도하십시오.

예시

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