Test Audit Webhook

fastapiusersauth

string

required

application/json

Settings for audit logging.

audit_webhook_url

string | null

Webhook URL that receives streamed audit events. When unset, audit events are skipped.

audit_webhook_custom_headers

Audit Webhook Custom Headers · object | null

Custom headers to include in audit webhook requests. Header names are case-insensitive.

Show child attributes

audit_webhook_custom_payload

Audit Webhook Custom Payload · object | null

Custom JSON fields merged into streamed audit event payloads. Canonical audit event fields take precedence; conflicting custom keys are ignored.

audit_webhook_payload_attribute

string | null

Optional wrapper key for audit payloads. When set to a value like 'event', payload is sent as {'event': <audit_payload>}.

audit_webhook_verify_ssl

boolean

default:true

Whether TLS certificates are verified for webhook requests. Disable only for trusted on-prem/self-signed endpoints.

Successful Response

Result of a synchronous audit webhook test-fire request.

boolean

required

receiver_status_code

integer | null

error_category

enum<string> | null

Available options:

receiver_error,

timeout,

request_error