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

# List webhook event types

`GET /v1/webhook-event-types`

## Request

- Base URL: `https://api.scrip.dev`
- URL: `https://api.scrip.dev/v1/webhook-event-types`
- Auth: HTTP bearer

List every webhook event type with its category and a sample `data` object.
A catalog list does not accept created_after or created_before.

## Response `200`

Every webhook event type

- WebhookEventTypeListResponse: One page of webhook event types, with the pagination details for the next page.
  - `data` WebhookEventTypeResponse[]: The webhook event types on this page.
    - `category` 'movement' | 'lifecycle': `movement` events announce one journal entry each. `lifecycle` events announce a resource changing state.
    - `description` string: One sentence saying when the event fires.
    - `sample_payload` object: A sample of the envelope's `data` object for this type, filled with sample ids.
    - `type` string: The event type, as it appears in an envelope's `type` and in `enabled_events`.
  - `pagination` PaginationResponse: Cursor details for a list. `has_more` says whether another page exists, and `next_cursor` is the value to send to get it.
    - `has_more` boolean, required: Whether more results are available beyond this page
    - `next_cursor` string, nullable, required: Cursor to fetch the next page. Null on the last page

## Other responses

- `401`: The API key is missing or not valid. See [Authentication](https://docs.scrip.dev/authentication).
- `403`: The caller is not allowed to do this.
- `429`: Too many requests. Wait the number of seconds in the `Retry-After` header, then retry. See [Limits and durations](https://docs.scrip.dev/limits#rate-limits).
- `500`: Something failed on Scrip's side. Retry the request, and quote `request_id` if it keeps failing. [Errors](https://docs.scrip.dev/errors) lists every code, and the [API introduction](https://docs.scrip.dev/api-reference/introduction) describes the error format.

---

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