Home Schema Example JSON Schema

Triggered Alert Metadata

Type: object

Metadata for triggered alert such as the rule at time of trigger.

 No Additional Properties

root alert_reasons

Alert Reasons

Type: array of object

Array of reasons why the alert was raised.

Must contain a minimum of 0 items

No Additional Items

Each item of this array must be:

root alert_reasons alert_reasons items
Type: object
No Additional Properties

root alert_reasons alert_reasons items reason

Reason

Type: string

Human readable description of the reason for this alert.

Must be at least 1 characters long

root alert_reasons alert_reasons items submission_value

Submission Value

Type: object or null

The submission value that triggered this alert. This is a dictified version of the SubmissionValue model.

Additional Properties of any type are allowed.

root alert_reasons alert_reasons items submission_value additionalProperties
Type: object

root alert_rule

Alert Rule

Type: object

The dictified alert rule that triggered this alert. This is important for audit and debugging.

The following properties are required:

  • name
  • parser_import_path
  • parser_settings

Additional Properties of any type are allowed.

root alert_rule additionalProperties
Type: object