Skip to main content
POST
Create
🔑 Requires the announcement_rules.create scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Body

application/json
condition_groups
object[]
required

Incidents are announced when they match any of these condition groups

Example:
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"

update_sharing_mode
enum<string>
required

Where incident updates are shared once the incident is announced

Available options:
none,
thread,
thread_and_channel
Example:

"none"

conditions_no_longer_apply_behaviour
enum<string>

Whether to remove announcement posts when the incident no longer matches this rule's conditions. Defaults to leaving them in place.

Available options:
leave_in_place,
remove
Example:

"leave_in_place"

microsoft_teams_channel_ids
string[]

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

Example:
owning_team_ids
string[]

IDs of the teams that own this rule

Example:
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. Defaults to none on create, and is left unchanged on update when omitted.

Available options:
all,
owning_teams,
none
Example:

"all"

slack_channel_ids
string[]

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

Example:
template_id
string

ID of the announcement template used to render this rule's posts. Defaults to the organisation's default template when omitted.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Response

Created response.

announcement_rule
object
required

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