---
title: "Read a webhook subscription."
method: GET
path: "/v1/webhook_endpoints/{id}"
---

# Read a webhook subscription.

`GET /v1/webhook_endpoints/{id}`

## Request

- Base URL: `https://paperagent.dev`
- URL: `https://paperagent.dev/v1/webhook_endpoints/{id}`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://paperagent.dev/oauth/authorize`, token URL `https://paperagent.dev/oauth/token`, scopes: `letters:read`)
  - API key in header `X-Api-Key`
  - HTTP bearer

## Path parameters

- `id` string, required

## Response `200`

Success

- object
  - `id` string, required
  - `url` string, required
  - `events` string[], required
  - `active` boolean, required
  - `livemode` boolean, required
  - `disabled_reason` string, nullable, required
  - `consecutive_failures` number, required
  - `created_at` string, required

## Other responses

- `default`: A stable error code and actionable message. 401: authenticate; 403: permission or policy; 404: unavailable object; 409: conflict; 422: domain refusal; 429: quota; 5xx: retry or contact support.

---

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