Client Settings

Get webhook settings

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.

get/client/webhook

Request

Base URL
http://127.0.0.1:5000/api/v1
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.

Webhook settings retrieved successfully

webhook_urlstring uri nullable required

Saved webhook endpoint.

webhook_configuredboolean required

Whether a webhook URL is configured.

webhook_secret_configuredboolean required

Whether a webhook signing secret is configured.

webhook_secretstring nullable required

Always null when retrieving existing webhook settings. Secrets are never returned by GET.

No recorded changes to this operation across all 1 revision of this API.