Integrate Opsgenie Monitoring
Overview
You can configure an Opsgenie integration to automatically create alerts for file transfer activities and device status changes.
Once configured, whenever a selected event occurs—such as Transfer Started, Transfer Completed, Device Connected, or Device Disconnected—an alert is automatically created in Opsgenie.
The overall process consists of the following steps:
① Generate an API Key and Verify the Region → ② Configure the Integration in the Product
Prerequisites
Before you begin, verify the following requirements.
| Item | Description |
|---|---|
| Opsgenie Account | An Opsgenie account with permission to create API Integrations. |
| Region | Verify whether your Opsgenie instance is hosted in the US or EU region. |
| Network | The environment where the product is installed must be able to access the appropriate Opsgenie API endpoint (api.opsgenie.com or api.eu.opsgenie.com) over HTTPS (443). |
Generate an Opsgenie API Key and Verify the Region
To create alerts in Opsgenie, create an API Integration to obtain an API Key and verify your instance Region.
Step 1. Create an API Integration and Generate an API Key
In Opsgenie, navigate to Settings → Integrations, then select Add Integration → API.
Enter a name for the integration and save it.
Under Steps to configure the integration, copy the generated API Key.
Then click Turn on integration to activate the integration.
Only API Keys generated from an API Integration can be used for creating alerts. API Keys created under API Key Management are not supported for this integration.
Treat the API Key like a password. Do not expose it in public repositories or external documentation.
If the key is compromised, regenerate the API Key or delete the integration.
Step 2. Verify the Region
Verify whether your Opsgenie instance is hosted in the US or EU region.
- US:
api.opsgenie.com - EU:
api.eu.opsgenie.com
The selected Region in the product must match your Opsgenie instance.
Verification
✔ The API Integration has been created and enabled.
✔ The API Key has been copied.
✔ The Opsgenie Region has been verified.
Configure the Opsgenie Integration
Enter the API Key and Region into the product.
When you open the Monitoring configuration page, the following screen is displayed.
Step 1. Enter the API Key
Enter the generated API Key.
Step 2. Select the Region
Select the Region that matches your Opsgenie instance.
Step 3. Select Events
Select the events to monitor.
Multiple events can be selected. Alerts will be created only for the selected events.
| Event | Trigger |
|---|---|
| Transfer Started | When a Transfer begins. |
| Transfer Completed | When a Transfer completes successfully. |
| Transfer Paused | When a Transfer is paused. |
| Transfer Recovered | When a Transfer automatically resumes after an interruption or failure. |
| Device Connected | When a device connects. |
| Device Disconnected | When a device disconnects. |
Step 4. Save the Configuration
After completing the configuration, click Add to save the integration.
Verification
✔ The API Key has been entered.
✔ The Region has been selected.
✔ The monitoring events have been selected.
Verify the Integration
Verify that the integration is operating correctly.
Step 1. Generate a Test Event
Start a Transfer or trigger one of the selected monitoring events.
Step 2. Verify in Opsgenie
Open Alerts in Opsgenie and verify that a new alert has been created.
Verification
✔ An alert has been created in Opsgenie.
✔ The generated event has been delivered successfully.
Configuration Complete
After the configuration is saved, the integration becomes active.
From this point forward, whenever one of the selected events occurs, a corresponding alert is automatically created in Opsgenie.
Troubleshooting
| Issue | Verification |
|---|---|
| Alerts are not created | Verify that the API Key and Region are correct and contain no leading or trailing spaces. |
| Integration is not working | Verify that the API Integration is in the Turn on state. |
| Authentication or permission error | Verify that the API Key was generated from an API Integration. API Keys created under API Key Management are not supported. |
| Region mismatch | Verify that the selected Region matches your Opsgenie instance. |
| Connection failure | Verify that access to the appropriate Opsgenie API endpoint (HTTPS 443) is allowed by the firewall or proxy. |