---
title: "One webhook endpoint"
method: GET
path: "/v1/webhooks/{id}"
tags: ["Webhooks"]
---

# One webhook endpoint

`GET /v1/webhooks/{id}`

## Request

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

## Path parameters

- `id` string, required

## Response `200`

The endpoint.

- object
  - `success` unknown, required
  - `data` object, required: The endpoint, directly; there is no `webhook` wrapper. Same shape as a row of the listing, and it never carries `secret` either: a signing secret appears only in the successful response that creates or explicitly rotates it.
    - `webhook_id` string, required: What the get, update, delete and test operations take as `{id}`.
    - `url` string, uri, nullable, required: The canonical callback URL. `null` identifies a malformed legacy endpoint that cannot deliver; repair it with PUT or delete it.
    - `description` string, nullable
    - `events` string[], required
    - `is_active` boolean, required: False means Kawaa has stopped delivering to it. Set it back with the update operation; `disabled_reason` says why when Kawaa switched it off.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time: Falls back to `created_at` on an endpoint that has never been changed.
    - `last_triggered_at` string, date-time, nullable: Null on an endpoint that has never fired, which is not the same as one that is failing.
    - `failure_count` integer: Consecutive delivery failures. A rising number beside a recent `last_triggered_at` is an endpoint that is being called and refusing.
    - `disabled_reason` 'api_key_revoked' | 'app_disconnected' | 'null', nullable: Why Kawaa switched this endpoint off: `api_key_revoked` (an API key that created it, or that pointed it at its current URL (or, when none did, changed its events or turned it on), or the key behind a dashboard session that did, was revoked) or `app_disconnected` (a connected app that created it or did one of those was disconnected, including by a password change or reset or an account lock). The endpoint is kept, with `is_active: false`, so its owner can review it and turn it back on or delete it. `null` while it is on, and for an endpoint someone switched off.

## Other responses

- `401`: No credential, or one that is not accepted. `code` distinguishes `API_KEY_SUSPENDED` (subscription ended; restartable) from `API_KEY_REVOKED`, `SESSION_EXPIRED` and `OAUTH_TOKEN_EXPIRED` (a connected app's one-hour access token lapsed: refresh it and retry, or sign in again if no refresh token was issued or the refresh is refused).
- `403`: Refused, and **the code says which of three problems it is**, and they need different remedies: - `INSUFFICIENT_SCOPE`: the credential is valid but not scoped for this route. With an API key, issue one that carries the scope named in the message. With an OAuth access token, connect the app again asking for that scope as well as the ones it has, unless the message says a connected app can never be given it; then use an API key with every scope the message names, or have the account owner do it in the dashboard. - `PLAN_UPGRADE_REQUIRED`: the account's plan does not include the feature. **No key of any scope reaches it**, so issuing another is wasted work; the remedy is a plan change. Returned by the verification routes for `options.enrich`, and by the finder, the monitors, the audit log, auto-clean and the white-label routes. - `PLAN_LIMIT_EXCEEDED`: the plan includes the feature and the account is at its ceiling (webhook endpoints, team seats, integrations, auto-clean lists). Delete one or upgrade. - `FORBIDDEN`: refused for a reason none of the above covers. `ErrorCode` is an open set, so branch on the code with a default rather than exhaustively.
- `404`: No such resource on this account.
- `429`: Too many requests. When the server knows how long to wait, `Retry-After` says so and `error.retry_after_seconds` carries the same number; the `X-RateLimit-*` headers say where you stand.
- `default`: Any status this operation does not list. Kawaa's own errors carry the error envelope. The gateway in front of the API can answer any operation with its own bare body (`GatewayError`): a `503` after about 29 seconds, when the request may still have run and been charged, a `413` for a body over about 6 MB, or a `400` for a path with malformed percent-encoding.

---

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