---
title: "List webhook event types"
method: GET
path: "/webhook-event-types"
tags: ["Webhooks"]
---

# List webhook event types

`GET /webhook-event-types`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/webhook-event-types`
- Auth: API key in header `API-Key`

Returns event types that can be subscribed to by webhook subscriptions.

Required scope: `webhooks:read`

## Query parameters

- `source` 'keycloak' | 'platform'

## Response `200`

The request has succeeded.

- WebhookEventType[]
  - `type` string, required
  - `category` 'auth' | 'user' | 'admin' | 'tokens' | 'mfa' | 'email' | 'federated' | 'client' | 'consent' | 'identity_provider' | 'credential' | 'security' | 'organization' | 'verifiable_credentials' | 'cluster' | 'extension' | 'theme' | 'domain' | 'migration' | 'export' | 'backup', required
  - `description` string, required
  - `deprecated` boolean, required
  - `sample_payload` object, nullable, required

## Other responses

- `400`: The server could not understand the request due to invalid syntax.
- `401`: Access is unauthorized.
- `403`: Access is forbidden.
- `404`: The server cannot find the requested resource.
- `422`: Client error
- `429`: Client error
- `500`: Server error
- `501`: Server error

---

[API](https://skmtc.dev/skycloak/apis/skycloak-public-api.md) · [All operations](https://skmtc.dev/skycloak/apis/skycloak-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/skycloak/apis/skycloak-public-api/revisions/33a69e2ce35f?raw)