---
title: "Lists every webhook endpoint of the authenticated account."
method: GET
path: "/api/webhooks"
tags: ["webhooks"]
---

# Lists every webhook endpoint of the authenticated account.

`GET /api/webhooks`

## Request

- Base URL: `https://api.pricklymails.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pricklymails.com/api/webhooks`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Response `200`

The caller's webhook endpoints.

- WebhookResponse[]
  - `consecutive_failures` integer, required: Number of failed deliveries in a row since the last success.
  - `created_at` string, required: RFC 3339 creation timestamp.
  - `description` string, nullable: Description of the endpoint, omitted when none was set.
  - `events` string[], required: Events the endpoint is subscribed to.
  - `last_delivery_at` string, nullable: RFC 3339 timestamp of the last delivery, omitted when there was none.
  - `status` string, required: Status of the endpoint: `"active"`, `"paused"` or `"disabled"`.
  - `successful_deliveries` integer, required: Number of deliveries the endpoint acknowledged with a 2xx status.
  - `total_deliveries` integer, required: Number of deliveries attempted.
  - `url` string, required: URL that receives the notifications.
  - `uuid` string, required: Public UUID of the endpoint.

## Other responses

- `401`: Missing or invalid API key, session token, or agent token.
- `403`: The key or agent token lacks the `webhooks:read` scope.

---

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