Client Settings

Update webhook settings

Updates the saved webhook configuration for the authenticated client.

webhook_url may be changed to an HTTP or HTTPS URL. Setting webhook_url to null disables the webhook and removes the stored signing material.

Set rotate_secret to true to generate a new webhook signing secret.

When a new webhook secret is generated, the plaintext secret is returned only in that immediate response. Save it securely because it will not be returned again.

Changing only the webhook URL does not rotate an existing signing secret.

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

patch/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/patch.ts
A function with typed inputs. Its response is checked against the schema.

Request body

webhook_urlstring uri nullable

HTTP or HTTPS webhook URL. Set to null to disable the webhook.

rotate_secretboolean

Generate a new webhook signing secret.

Response

Webhook settings updated successfully

successboolean required

webhook_urlstring uri nullable required

webhook_configuredboolean required

webhook_secret_configuredboolean required

webhook_secretstring nullable required

Plaintext webhook signing secret. Returned only when a secret is newly generated or rotated. Save it securely because it will not be returned again.

secret_rotatedboolean required

Whether a new signing secret was generated.

warningstring nullable

Example response

{
  "success": true,
  "warning": "Save the webhook secret now. It will not be returned again."
}

Changes

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