---
title: "Get webhook settings"
method: GET
path: "/client/webhook"
tags: ["Client Settings"]
---

# Get webhook settings

`GET /client/webhook`

## Request

- Base URL: `http://127.0.0.1:5000/api/v1`
- URL: `http://127.0.0.1:5000/api/v1/client/webhook`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/clinicalauditai/apis/clinicalauditai-api/docs/client/webhook/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the saved webhook configuration for the authenticated
client.

The webhook signing secret is never returned by this endpoint.

This endpoint is available only to client API keys. The master API
key cannot use client self-service settings.

## Response `200`

Webhook settings retrieved successfully

- ClientWebhookSettings
  - `webhook_url` string, uri, nullable, required: Saved webhook endpoint.
  - `webhook_configured` boolean, required: Whether a webhook URL is configured.
  - `webhook_secret_configured` boolean, required: Whether a webhook signing secret is configured.
  - `webhook_secret` string, nullable, required: Always null when retrieving existing webhook settings. Secrets are never returned by GET.

## Other responses

- `401`: Missing or invalid API key
- `403`: Client API key required
- `500`: Failed to retrieve webhook settings

---

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