settings

Test Audit Webhook

Probe the submitted audit webhook configuration with a marked test event.

post/settings/audit/test

Request

audit_webhook_urlstring nullable

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

audit_webhook_custom_headersobject nullable

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

audit_webhook_custom_payloadobject nullable

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

audit_webhook_payload_attributestring nullable

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

audit_webhook_verify_sslboolean

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

Successful Response

okboolean required

receiver_status_codeinteger nullable

error_category'receiver_error' | 'timeout' | 'request_error' nullable

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