---
title: "List Webhook Event Types"
method: GET
path: "/v2/webhooks/event-types"
tags: ["webhooks"]
---

# List Webhook Event Types

`GET /v2/webhooks/event-types`

List the five job events with a description, the payload schema version and a JSON Schema (draft 7) for each payload. Each schema carries an example payload under `examples`, the same body the test endpoint sends.

Every indexing job sends exactly one of these events when it reaches its final status. See the [Webhooks](/guides/webhooks) guide.

## Response `200`

Successful Response

- WebhookEventTypeList
  - `event_types` WebhookEventType[], required
    - `name` 'job.completed' | 'job.completed_with_errors' | 'job.failed' | 'job.timed_out' | 'job.cancelled', required
    - `description` string, required
    - `schema_version` string, required — Payload schema version. Currently `1`.
    - `schema` object, required — JSON Schema (draft 7) of the event payload, with an example under `examples`.

## Other responses

- `401` — Missing or invalid API key.
- `429` — `Too many webhook management requests. Try again shortly.` Retry after the `Retry-After` header.

## Changes

- **2026-09-24** `61a9364ad042` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/runcaptain/apis/api-reference/changes/v2/webhooks/event-types/get.md)

---

[API](https://skmtc.dev/runcaptain/apis/api-reference.md) · [All operations](https://skmtc.dev/runcaptain/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/runcaptain/apis/api-reference/revisions/ac61e472bb7d?raw)