Atlassian OpsGenie

LAST UPDATED: SEPTEMBER 18, 2025

Overview

Opsgenie is a cloud-based incident management platform that ensures alerts from your monitoring systems and custom applications are well managed, so that critical incidents are never missed, and actions are taken by the right people in the shortest possible time. This integration enables organizations to manage on-call schedules and other items.

D3 SOAR is providing REST operations to function with Atlassian OpsGenie.

Atlassian OpsGenie is available for use in:

Known Limitations

Refer to OpsGenie > Rate Limiting for details on rate limiting.

Connection

To connect to Atlassian OpsGenie from D3 SOAR, follow this part to collect the required information below:

Permission Requirements

Each endpoint in the Atlassian OpsGenie API requires a certain permission scope. For all commands in this integration both the Read and Configuration access rights are needed.

READER NOTE

The API key is controlled by the access rights configured for the API key. There are four access rights to choose from:

• Read

• Create and update

• Delete

• Configuration access

For instructions on how to obtain the API key and configure the access rights, refer to the Configuring Atlassian OpsGenie to Work with D3 SOAR section below.

Configuring Atlassian OpsGenie to Work with D3 SOAR

1. Log into OpsGenie.

2. Navigate to Settings > API key management.

   

3. Click on the Add new API key button.

   

4. Enter the Name for the new API key in the popup, copy the Key and store it for future reference, then select the appropriate Access rights (refer to Permission Requirements). Finally, click on the Add API key button.

   

5. Locate the newly created API Key on the API key management list.

   

Configuring D3 SOAR to Work with Atlassian OpsGenie

1. Log in to D3 SOAR.

2. Find the Atlassian OpsGenie integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type Atlassian OpsGenie in the search box to find the integration, then click it to select it.

   4. Click + Connection, on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to Atlassian OpsGenie.

   

   1. Connection Name: The desired name for the connection.

   2. Site: The site on which to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.

   4. Agent Name (Optional): The proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): The description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, users can choose the specific tenant sites with which to share the connection. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.

      

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: The checkbox that enables the connection to be used when selected.

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.

      

      1. Input the Server URL. The default value is https://api.opsgenie.com.
      2. Copy the API Key from the Atlassian OpsGenie platform. Refer to step 5 of Configuring Atlassian OpsGenie to Work with D3 SOAR.
      3. Input the API Version. The default value is v2.

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.

   11. Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.

4. Test the connection.

   

   1. Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

Atlassian OpsGenie includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, users can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Atlassian OpsGenie API, refer to the Atlassian OpsGenie API reference.

READER NOTE

Certain permissions are required for each command. Refer to the Permission Requirements and Configuring Atlassian OpsGenie to Work with D3 SOAR for details.

Note for Time-related parameters

The input format of time-related parameters may vary based on user account settings, which may cause the sample data in commands to differ from what is displayed. To adjust the time format, follow these steps:

1. Navigate to Configuration > Application Settings. Select Date/Time Format.

   

2. Choose the desired date and time format, then click on the Save button.

   

The selected time format will now be visible when configuring Date/Time command input parameters.

Fetch Event

Retrieves alerts matching the given criteria.

Input

Output

To view the sample output data for all commands, refer to this article.

Fetch Event Field Mapping

See Field Mappings. 

The Atlassian OpsGenie system integration includes pre-configured field mappings for the default event source.

The Default Event Source is the default system-provided set of field mappings applied when the fetch event command is executed. It includes a Main Event JSON Path, which is the JSONPath expression that points to the base array of event objects. The source field path continues from this array to locate the required data. 

The Main Event JSON Path can be viewed by clicking on the Edit Main JSON Path button.

• Main Event JSON Path: $.data
  The data array contains the event objects. Within each object, the key id denotes the Unique Event Key field. As such, the full JSONPath expression to extract the Unique Event Key is $.data.id.

The pre-configured field mappings are detailed below:

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Get On-call User

Retrieves current on-call participants for a specific schedule.

READER NOTE

Schedule Name is a required parameter to run this command.

• Run the Get Schedules command to obtain the Schedule Name. Schedule Names can be found in the raw data at the path $.data[*].name.

Input

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Get Schedules

Retrieves all schedules.

Input

N/A

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Get Schedule Timeline

Retrieves the schedule’s timeline, which includes the time and on-call recipient details.

READER NOTE

Schedule Name is a required parameter to run this command.

• Run the Get Schedules command to obtain the Schedule Name. Schedule Names can be found in the raw data at the path $.data[*].name.

Input

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Get Single User

Retrieves a single user.

READER NOTE

Username or ID is a required parameter to run this command.

• Run the Get On-call User command to obtain the Username or ID. Usernames can be found in the raw data at the path $.onCallParticipants[*].name; IDs can be found in the raw data at the path $.onCallParticipants[*].id.

Input

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Test Connection

Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.