Skip to main content

Component: opsgenie-team

This component is responsible for provisioning Opsgenie teams and related services, rules, schedules.



You need an API Key stored in /opsgenie/opsgenie_api_key of SSM, this is configurable using the ssm_parameter_name_format and ssm_path variables.

Opsgenie is now part of Atlassian, so you need to make sure you are creating an Opsgenie API Key, which looks like abcdef12-3456-7890-abcd-ef0123456789 and not an Atlassian API key, which looks like


Generate an API Key by going to Settings -> API key management on your Opsgenie control panel, which will have an address like https://<your-org>, and click the "Add new API key" button. For more information, see the Opsgenie API key management documentation.

Once you have the key, you'll need to test it with a curl to verify that you are at least on a Standard plan with OpsGenie:

curl -X GET '' \
--header "Authorization: GenieKey $API_KEY"

The result should be something similar to below:

"data": {
"name": "opsgenie",
"plan": {
"maxUserCount": 1500,
"name": "Enterprise",

If you see Free or Essentials in the plan, then you won't be able to use this component. You can see more details here: OpsGenie pricing/features

Getting Started

Stack Level: Global

Here's an example snippet for how to use this component.

This component should only be applied once as the resources it creates are regional, but it works with integrations. This is typically done via the auto or corp stack (e.g. gbl-auto.yaml).

# 9-5 Mon-Fri
business_hours: &business_hours
type: "weekday-and-time-of-day"
- start_hour: 9
start_min: 00
start_day: "monday"
end_hour: 17
end_min: 00
end_day: "friday"

# 9-5 Every Day
waking_hours: &waking_hours
type: "time-of-day"
- start_hour: 9
start_min: 00
end_hour: 17
end_min: 00

# This is a partial incident mapping, we use this as a base to add P1 & P2 below. This is not a complete mapping as there is no P0
priority_level_to_incident: &priority_level_to_incident
enabled: true
type: incident
priority: P1
order: 1
notify: # if omitted, this will default to the default schedule
type: schedule
name: default
type: "match-all-conditions"
- field: priority
operation: equals
expected_value: P0

p1: &p1_is_incident
<<: *priority_level_to_incident
priority: P1
type: "match-all-conditions"
- field: priority
operation: equals
expected_value: P1

p2: &p2_is_incident
<<: *priority_level_to_incident
priority: P2
type: "match-all-conditions"
- field: priority
operation: equals
expected_value: P2

# defaults
type: abstract
component: opsgenie-team

enabled: false
description: "London Schedule"
timezone: "Europe/London"

# Routing Rules determine how alerts are routed to the team,
# this includes priority changes, incident mappings, and schedules.
enabled: false
type: alert
timezone: Europe/London
type: schedule # could be escalation, could be none
name: london_schedule
time_restriction: *waking_hours
type: "match-all-conditions"
- field: priority
operation: greater-than
expected_value: P2

# Since Incidents require a service, we create a rule for every `routing_rule` type `incident` for every service on the team.
# This is done behind the scenes by the `opsgenie-team` component.
# These rules below map P1 & P2 to incidents, using yaml anchors from above.
p1: *p1_is_incident
p2: *p2_is_incident

# New team
type: real
component: opsgenie-team
- opsgenie-team-defaults
enabled: true
name: sre

# These members will be added with an opsgenie_user
# To clickops members, set this key to an empty list `[]`
- user: [email protected]
role: owner

enabled: true
name: otherteam_escalation
description: Other team escalation
condition: if-not-acked
notify_type: default
delay: 60
- type: team
name: otherteam

enabled: true
name: yaep_escalation
description: Yet another escalation policy
condition: if-not-acked
notify_type: default
delay: 90
- type: user
name: [email protected]

enabled: true
name: schedule_escalation
description: Schedule escalation policy
condition: if-not-acked
notify_type: default
delay: 30
- type: schedule
name: secondary_on_call

The API keys relating to the Opsgenie Integrations are stored in SSM Parameter Store and can be accessed via chamber.

AWS_PROFILE=foo chamber list opsgenie-team/<team>

ClickOps Work

  • After deploying the opsgenie-team component the created team will have a schedule named after the team. This is purposely left to be clickOps’d so the UI can be used to set who is on call, as that is the usual way (not through code). Additionally, we do not want a re-apply of the Terraform to delete or shuffle who is planned to be on call, thus we left who is on-call on a schedule out of the component.

Known Issues

Different API Endpoints in Use

The problem is there are 3 different api endpoints in use

  • /webapp - the most robust - only exposed to the UI (that we've seen)
  • /v2/ - robust with some differences from webapp
  • /v1/ - the oldest and furthest from the live UI.

Cannot create users

This module does not create users. Users must have already been created to be added to a team.

Cannot Add dependent Services

  • Api Currently doesn't support Multiple ServiceIds for incident Rules

Cannot Add Stakeholders

No Resource to create Slack Integration

Out of Date Terraform Docs

Another Problem is the terraform docs are not always up to date with the provider code.

The OpsGenie Provider uses a mix of /v1 and /v2. This means there are many things you can only do from the UI.

Listed below in no particular order

  • Incident Routing cannot add dependent services - in v1 and v2 a service_incident_rule object has serviceId as type string, in webapp this becomes serviceIds of type list(string)
  • Opsgenie Provider appears to be inconsistent with how it uses time_restriction:
    • restrictions for type weekday-and-time-of-day
    • restriction for type time-of-day

Unfortunately none of this is in the terraform docs, and was found via errors and digging through source code.

Track the issue:

GMT Style Timezones

We recommend to use the human readable timezone such as Europe/London.

  • Setting a schedule to a GMT-style timezone with offsets can cause inconsistent plans.

    Setting the timezone to Etc/GMT+1 instead of Europe/London, will lead to permadrift as OpsGenie converts the GMT offsets to regional timezones at deploy-time. In the previous deploy, the GMT style get converted to Atlantic/Cape_Verde.

    # module.routing["london_schedule"].module.team_routing_rule[0].opsgenie_team_routing_rule.this[0] will be updated in-place
    ~ resource "opsgenie_team_routing_rule" "this" {
    id = "4b4c4454-8ccf-41a9-b856-02bec6419ba7"
    name = "london_schedule"
    ~ timezone = "Atlantic/Cape_Verde" -> "Etc/GMT+1"
    # (2 unchanged attributes hidden)

    Some GMT styles will not cause a timezone change on subsequent applies such as Etc/GMT+8 for Asia/Taipei.

  • If the calendar date has crossed daylight savings time, the Etc/GMT+ GMT style will need to be updated to reflect the correct timezone.

Track the issue:


terraform>= 1.3.0
aws>= 4.9.0
datadog>= 3.3.0
opsgenie>= 0.6.7


aws>= 4.9.0
datadog>= 3.3.0
opsgenie>= 0.6.7




aws_ssm_parameter.opsgenie_api_keydata source
aws_ssm_parameter.opsgenie_team_api_keydata source
opsgenie_team.existingdata source
opsgenie_user.team_membersdata source


additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
create_only_integrations_enabledWhether to reuse all existing resources and only create new integrationsboolfalseno
datadog_integration_enabledWhether to enable Datadog integration with opsgenie (datadog side)booltrueno
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
escalationsEscalations to configure and create for the{}no
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
integrationsAPI Integrations for the team. If not specified, datadog is{}no
integrations_enabledWhether to enable the integrations submodule or notbooltrueno
kms_key_arnAWS KMS key used for writing to SSMstring"alias/aws/ssm"no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
membersMembers as objects with their role within the team.set(any)[]no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Regionstringn/ayes
routing_rulesRouting Rules for the teamanynullno
schedulesSchedules to create for the teammap(any){}no
servicesServices to create and register to the{}no
ssm_parameter_name_formatSSM parameter name formatstring"/%s/%s"no
ssm_pathSSM pathstring"opsgenie"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
team_nameCurrent OpsGenie Team Namestringnullno
team_naming_formatOpsGenie Team Naming Formatstring"%s_%s"no
team_optionsConfigure the team options.
See opsgenie_team Terraform resource documentation for more details.
description = optional(string)
ignore_members = optional(bool, false)
delete_default_resources = optional(bool, false)
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


escalationEscalation rules created
integrationIntegrations created
routingRouting rules created
team_idTeam ID
team_membersTeam members
team_nameTeam Name



Changes in PR #889, expected Component version ~1.334.0

team replaced with team_options

The team variable has been replaced with team_options to reduce confusion. The component only ever creates at most one team, with the name specified in the name variable. The team variable was introduced to provide a single object to specify other options, but was not implemented properly.

Team membership now managed by this component by default

Previously, the default behavior was to not manage team membership, allowing users to be managed via the Opsgenie UI. Now the default is to manage via the members input. To restore the previous behavior, set team_options.ignore_members to true.