v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-263064641.4 MB
Portal Audit Logs

Update Portal Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

patch/v3/portals/{portalId}/audit-log-webhook

Request body

enabledboolean

Indicates if the data should be sent to the configured destination.

audit_log_destination_idstring uuid nullable

ID of the audit log destination.

include_principal_nameboolean

Whether to include the principal name in the audit log entries sent to the webhook.

Example request

{
  "enabled": true,
  "include_principal_name": true
}

Response

Portal audit log webhook response

enabledboolean

Indicates if the data should be sent to the configured audit log destination.

audit_log_destination_idstring uuid nullable

ID of the audit log destination.

include_principal_nameboolean

Whether to include the principal name in the audit log entries sent to the webhook.

Example response

{
  "enabled": true,
  "include_principal_name": true
}