Documentation Index

Fetch the complete documentation index at: https://docs.traceable.ai/llms.txt

Use this file to discover all available pages before exploring further.

APIST Alert Use Cases

Prev Next

Traceable's advanced alert conditions allow you to go beyond simple event triggers by comparing specific attributes against expected values or against each other. This is particularly useful for tracking scan state transitions, where you want to be notified only when a scan moves into a meaningful state, rather than on every update. The following table describes the different available attributes, event type, and its description:

Category attributes

Event Type

Description

Authentication Hook

  • Create

  • Update

  • Delete

Provides visibility into authentication configurations used during scan execution.

Plugin

  • Create

  • Update

  • Delete

Provides visibility into supported scanning and integration plugins.

Scan Run

  • Create

  • Update

  • Delete

Provides visibility into scan execution activity and results.

Runner

  • Create

  • Update

  • Delete

Provides visibility into configured scan runners and their execution status.


Advanced alert configuration sample scenarios

The following sample scenarios discuss how to configure condition groups and conditions for AST alerts when you select the Event Type as Update:

AST Advanced Alert Configuration

Scenario 1 — Notify when a scan starts running

You wish to be notified whenever a scan transitions into a Running state, so you can confirm that scheduled scans have started successfully. To configure this, create a condition group with Match All, and add the following conditions:

Attribute

Operator

Value

New Scan State

!=

Current Scan State

New Scan State

In

Scan Running

This configuration ensures that Traceable evaluates whether the scan has moved into a new state and confirms that the new state is one of the values associated with a running scan. As a result, you receive a notification only when a scan actually transitions to execution, not for redundant or unrelated updates.

Scenario 2 — Notify when a scan reaches its maximum test limit

You wish to be alerted when a scan reaches the configured test execution limit, so you can review whether the scan completed as expected or requires further investigation. To configure this, create a second condition group with Match Any, and add the following conditions:

Attribute

Operator

Value

New Scan State

=

Current Scan State

New Scan State

In

Max Test Limit Reached

This combination flags scans that have reached their maximum test limit, allowing you to review scan coverage and determine whether the limit needs to be adjusted for future runs.