---
title: "Read a webhook"
method: GET
path: "/v1/webhooks/{webhook_id}"
tags: ["webhooks"]
---

# Read a webhook

`GET /v1/webhooks/{webhook_id}`

## Request

- Base URL: `https://cherami.to`
- URL: `https://cherami.to/v1/webhooks/{webhook_id}`
- Auth: HTTP bearer

Returns one webhook, with the same fields as [the listing](https://cherami.to/docs/api/webhooks/list-webhooks).

## Path parameters

- `webhook_id` string, required

## Response `200`

Success.

- Webhook: status is active (delivering), disabled (not delivering until you set enabled to true; you or repeated delivery failures turned it off), pending (creation or removal not yet confirmed; read it again shortly) or unknown (the configuration couldn't be read and its fields are null; if it stays unknown, delete the webhook and add it again). pending_operation names the unconfirmed work.
  - `id` string, required: Cherami resource ID.
  - `created_at` string, date-time, required: UTC timestamp with milliseconds.
  - `url` string, nullable, required: Destination URL; null while status is pending or unknown.
  - `event_types` WebhookEventType[], nullable, required
  - `inbox_ids` string[], nullable, required: Scoped inboxes; empty means every inbox.
  - `deleted_inbox_ids` string[], required: Scoped inboxes that have since been deleted. They match nothing; edit inbox_ids to remove them.
  - `enabled` boolean, nullable, required
  - `updated_at` string, date-time, nullable, required: UTC timestamp with milliseconds.
  - `status` 'active' | 'disabled' | 'pending' | 'unknown', required
  - `pending_operation` object, nullable, required
    - `kind` 'create' | 'delete' | 'rotate', required
    - `started_at` string, date-time, required: UTC timestamp with milliseconds.
  - `secret_rotated_at` string, date-time, nullable, required: UTC timestamp with milliseconds.
  - `previous_secret_expires_at` string, date-time, nullable, required: UTC timestamp with milliseconds.

## Other responses

- `401`: `unauthorized`: Send a valid API key as `Authorization: Bearer <key>`. If the key stopped working, get a new one through [recovery](https://cherami.to/docs/guides/recovery).
- `404`: `not_found`: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.
- `503`: `webhooks_unavailable`: Webhook management failed. If it was a change, it may have been applied: list or read the webhooks before repeating it.

---

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