Opsgenie

Opsgenie is a comprehensive incident management and alerting platform that helps DevOps and IT teams respond to incidents faster, manage on-call schedules, and ensure reliable service delivery through intelligent alert routing, escalation policies, and collaboration tools.

Power end-to-end data operations for your Opsgenie API with Nexla. Our bi-directional Opsgenie connector is purpose-built for Opsgenie, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Opsgenie or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Opsgenie workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Opsgenie credential, you need to obtain your API key and identify your API instance URL from your Opsgenie account. Opsgenie uses API key authentication for all API requests, with the API key sent in the Authorization header with the GenieKey prefix.

To obtain your Opsgenie API credentials, follow these steps:

1. Sign in to your Opsgenie account using your administrator credentials.

2. Navigate to Settings > Integrations or Settings > API in the Opsgenie interface.

3. Look for the API Keys or API Integration section in your account settings.

4. If you don't have an API key yet, click Add API Integration or Create API Key to create a new API key.

5. Configure your API key settings:

   • Enter a name or description for the API key (e.g., "Nexla Integration")
   • Review and select the permissions or scopes for the key

6. Click Save or Create to create the API key.

7. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

8. Identify your API instance URL based on your Opsgenie instance:

   • US Instance: https://api.opsgenie.com
   • EU Instance: https://api.eu.opsgenie.com

9. Store both the API key and API instance URL securely, as you will need them to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization header with the GenieKey prefix (e.g., Authorization: GenieKey {api_key}) for all API requests to the Opsgenie API. The API instance URL determines which Opsgenie instance (US or EU) your API requests will be sent to. The API key authenticates your requests and grants access to Opsgenie resources based on your account permissions and the key's scopes. If your API key is compromised, you should immediately revoke it in your Opsgenie account settings and generate a new one. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the Opsgenie API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API URL	Yes	No	Select your Opsgenie API instance URL. Allowed values: https://api.opsgenie.com; https://api.eu.opsgenie.com
API Key	Yes	Yes	Enter your Opsgenie API Key.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Opsgenie

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Opsgenie API instance URL in the API URL field. Select https://api.opsgenie.com for US instances, or https://api.eu.opsgenie.com for EU instances. The API instance URL determines which Opsgenie instance your API requests will be sent to.

4. Enter your Opsgenie API key in the API Key field. This is the API key you obtained from your Opsgenie account settings (Settings > Integrations > API Keys). The API key is sent in the Authorization: GenieKey {api_key} header for all API requests to the Opsgenie API. The API key is sensitive information and must be kept confidential.

   Your Opsgenie API key can be found in your Opsgenie account settings under Settings > Integrations > API Keys. The API key is sent in the Authorization: GenieKey {api_key} header for all API requests to the Opsgenie API. The API instance URL should match your Opsgenie instance (US or EU).

   If your API key is compromised, you should immediately revoke it in your Opsgenie account settings and generate a new one. The API key provides access to your Opsgenie account data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

   For detailed information about obtaining API keys, API authentication, and available endpoints, see the Opsgenie API documentation.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Opsgenie connector tile, then select the credential that will be used to connect to your Opsgenie account, and click Next; or, create a new Opsgenie credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Opsgenie endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Resources

This endpoint template retrieves a list of records of a specific resource type from your Opsgenie account. Use this template when you need to retrieve alerts, incidents, users, schedules, or other Opsgenie resources.

• Select the resource type from the Resource Type pulldown menu. Available options include Alerts (v2/alerts), Incidents (v1/incidents), Users (v2/users), and Schedules (v2/schedules). The resource type determines which Opsgenie resource will be queried. Select the resource type that matches the data you want to retrieve.

This endpoint retrieves a list of records of a specific resource type from your Opsgenie account. The endpoint uses next URL-based pagination to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the paging.next URL returned in the API response.

Different resource types may have different data structures and available fields. For detailed information about resource types, API response structures, pagination, and available resource data, see the Opsgenie API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Opsgenie data sources can also be manually configured to ingest data from any valid Opsgenie API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Opsgenie API typically uses the GET method for retrieving data. The endpoint URL should include your API base URL and the resource type path (e.g., https://api.opsgenie.com/v2/alerts). For the Response Data Path, use $.data[*] to extract records from the data array, depending on your endpoint. The Opsgenie API uses next URL-based pagination with $.paging.next for most endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Opsgenie data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Opsgenie destination, and select the Send to Destination option from the menu. Select the Opsgenie connector from the list of available destination connectors, then select the credential that will be used to connect to your Opsgenie account, and click Next; or, create a new Opsgenie credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Opsgenie endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Alerts

This endpoint template sends each Nexset record as an alert to your Opsgenie account. Use this template when you need to create alerts in Opsgenie from your data, such as monitoring alerts, incident notifications, or system alerts.

• This endpoint automatically creates alerts from your data. No additional configuration is required beyond selecting this endpoint template. The request body should contain the alert data in JSON format matching the Opsgenie Alert API structure.

This endpoint sends data as JSON in the request body to create alerts in your Opsgenie account. Each record from your Nexset will be sent as a separate API request to create a new alert in Opsgenie. The request body should contain the alert data in the format required by the Opsgenie Alert API, including alert message, priority, tags, and other alert properties.

For detailed information about alert creation, request body formats, available alert properties, and alert management, see the Opsgenie Alert API documentation.

Create Incidents

This endpoint template sends each Nexset record as an incident to your Opsgenie account. Use this template when you need to create incidents in Opsgenie from your data, such as service incidents, outage notifications, or maintenance events.

• This endpoint automatically creates incidents from your data. No additional configuration is required beyond selecting this endpoint template. The request body should contain the incident data in JSON format matching the Opsgenie Incident API structure.

This endpoint sends data as JSON in the request body to create incidents in your Opsgenie account. Each record from your Nexset will be sent as a separate API request to create a new incident in Opsgenie. The request body should contain the incident data in the format required by the Opsgenie Incident API, including incident message, priority, impact, and other incident properties.

For detailed information about incident creation, request body formats, available incident properties, and incident management, see the Opsgenie Incident API documentation.

Manual configuration

Opsgenie destinations can also be manually configured to send data to any valid Opsgenie API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Opsgenie API typically uses the POST method and expects JSON format for all requests. The endpoint URL should include your API base URL and the resource type path (e.g., https://api.opsgenie.com/v2/alerts). The request body is typically {message.json} to send the entire Nexset data as JSON, or a custom JSON structure with specific field mappings matching the Opsgenie Alert or Incident API structure.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Opsgenie endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Opsgenie endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.