Generate Audit Event
The Generate Audit Event
action creates custom audit events that are logged and available in your project's Audit page and any connected services. This action allows you to track specific business events, user actions, or system activities that are important for compliance, monitoring, or debugging purposes.
Custom audit events generated through this action will appear alongside standard Descope audit events, providing a comprehensive audit trail for your application.
Configuration
The Generate Audit Event
action allows you to specify:
- Step Name: The name of the step within the flow
- Action: A descriptive name for the event
- Type: Choose from three severity levels:
- Information: General events for tracking normal operations
- Warning: Events that indicate potential issues or unusual behavior
- Error: Events that represent failures or security concerns
- Event Data: Any relevant data from the flow context, including user information, timestamps, or custom parameters
Flow Implementation
To generate a custom audit event within a flow, simply add the action at the relevant point of the flow.
Viewing Audit Events
Generated audit events will appear in your project's Audit page with the following information:
- Event timestamp
- Action name
- Event type (with appropriate severity indicators)
- Event data (as JSON)
- User information (if available)
- Flow context details
You can filter and search these events using the audit page's built-in search and filtering capabilities.
Additionally, these audit events will be streamed alongside default events to any configured Analytics connectors.
Custom audit events are subject to the same retention policies as standard Descope audit events.