Announcement Rules

Create and manage announcement rules. An announcement rule posts an announcement of each incident that matches its conditions into the channels it lists, rendered with an announcement template.

The announcement rule object

An announcement rule posts an announcement of matching incidents into one or more channels.

condition_groups

object[]

required

Incidents are announced when they match any of these condition groups

Show child attributes

Example:

[
  {
    "conditions": [
      {
        "operation": {
          "label": "Lawrence Jones",
          "value": "01FCQSP07Z74QMMYPDDGQB9FTG"
        },
        "param_bindings": [
          {
            "array_value": [
              {
                "label": "Lawrence Jones",
                "literal": "SEV123",
                "reference": "incident.severity"
              }
            ],
            "value": {
              "label": "Lawrence Jones",
              "literal": "SEV123",
              "reference": "incident.severity"
            }
          }
        ],
        "subject": {
          "label": "Incident Severity",
          "reference": "incident.severity"
        }
      }
    ]
  }
]

conditions_no_longer_apply_behaviour

enum<string>

required

Whether to remove announcement posts when the incident no longer matches this rule's conditions

Available options:

leave_in_place,

remove

Example:

"leave_in_place"

created_at

string<date-time>

required

When the rule was created

Example:

"2021-08-17T13:28:57.801578Z"

string

required

Unique identifier for this announcement rule

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

microsoft_teams_channel_ids

string[]

required

Microsoft Teams channels to post announcements into, as team_id/channel_id, when the organisation uses Microsoft Teams

Example:

["19:abc@thread.tacv2/19:def@thread.tacv2"]

mode

enum<string>

required

Which incidents are announced: live incidents only, or triage incidents too

Available options:

live_and_closed,

include_triage,

include_triage_and_merged,

include_declined_and_merged,

include_all

Example:

"live_and_closed"

name

string

required

Human readable name for the rule

Example:

"Data Breaches"

owning_team_ids

string[]

required

IDs of the teams that own this rule

Example:

["01G0J1EXE7AXZ2C93K61WBPYEH"]

slack_channel_ids

string[]

required

IDs of the Slack channels to post announcements into, when the organisation uses Slack

Example:

["C02AW36C1M5"]

Where incident updates are shared once the incident is announced

Available options:

none,

thread,

thread_and_channel

Example:

"none"

updated_at

string<date-time>

required

When the rule was last updated

Example:

"2021-08-17T13:28:57.801578Z"

private_incident_scope

enum<string>

Which private incidents this rule announces: every private incident (all), those an owning team can see (owning_teams), or none

Available options:

all,

owning_teams,

none

Example:

"all"

template_id

string

ID of the announcement template used to render this rule's posts

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Getting started

Webhooks

Audit logs

Deprecated endpoints

The announcement rule object

​The announcement rule object

The announcement rule object