Event Scripts

Event Scripts are a series of logic rules which can be executed within a defined context in various places throughout the Helix system.

Most commonly, Event Scripts are utilised in the context of an incident, but can also be used for a resource and other objects and subsystems.

Event Script Syntax

Each Event Script is a YAML configuration file with the following structure:

id: 'unique-script-id'
trigger:
  - event: 'namespace:event'
    condition:
      - 'condition.value === true'
actions:
  - action: 'namespace:action'
    parameterOne: 'value'
    parameterTwo: 'value'

Script IDs

A Script ID must be unique to your Helix organisation. It is used within internal systems to identify and run your script, while also allowing you to reference it in other parts of the system.

The ID must be a string and can contain alphanumeric characters, hyphens, and underscores. The recommended format is [type]-script-name, e.g. incident-escalate-to-supervisor.

Triggers

The trigger section defines the context in which the Event Script will be executed. Like actions, triggers are defined using a namespace and event name, e.g. helix:incident_created.

Last modified: 24 December 2024