Overview#
You can configure Opsgenie integration to create and monitor alerts for file transfer tasks and device status changes.
After completing the integration, an alert is automatically created in Opsgenie whenever designated events occur, such as a transfer being Started (Transfer Started) or Completed (Transfer Completed), or a device being Connected (Device Connected) or Disconnected (Device Disconnected).
The entire process consists of two steps: ① Obtain an API Key and Check the Region → ② Configure the integration in the product.
Prerequisites#
Before you begin, check the following.
| Item | Description |
|---|---|
| Opsgenie account | An Opsgenie account with permission to add an API Integration is required. |
| Region | Check the region (US or EU) of the Opsgenie instance. |
| Network | Outbound HTTPS (443) communication to the Opsgenie API endpoint for the selected Region (api.opsgenie.com or api.eu.opsgenie.com) must be allowed from the environment where the product is installed. |
Obtain an Opsgenie API Key and Check the Region#
To create alerts in Opsgenie, add an API Integration, obtain an API Key, and check the instance Region.
Step 1. Create an API Integration and Obtain an API Key#
In Opsgenie, go to Settings → Integrations, then select API under Add Integration.
Enter a name and save it, then copy the API Key from Steps to configure the integration.
Then click Turn on integration to enable the Integration.
ℹ️ Only the API Key from an API Integration can be used to create alerts. Keys created in API Key Management cannot be used. An API Key has the same level of access as a password, so make sure it is not exposed in public repositories or external documents. If it is exposed, issue a new API Key from the Integration or delete the Integration.
Step 2. Check the Region#
Check whether the Opsgenie instance is in the US or EU region.
- US :
api.opsgenie.com - EU :
api.eu.opsgenie.com
It must match the Region in the product settings.
Checklist#
- ✔ The API Integration has been created and enabled.
- ✔ The API Key has been copied.
- ✔ The Opsgenie Region has been confirmed.
Configure Opsgenie Integration#
Enter the issued API Key and Region in the product.
When you open the Monitoring settings window, the following screen is displayed.
Step 1. Enter the API Key#
Enter the issued API Key in the API Key field.
Step 2. Select the Region#
Select the Opsgenie instance region under Region.
Step 3. Select Events#
Select the events to monitor under Events.
You can select multiple events, and alerts are created in Opsgenie only when the selected events occur.
| Event | When It Occurs |
|---|---|
| Transfer Started | When the transfer task starts |
| Transfer Completed | When the transfer task is completed successfully |
| Transfer Paused | When the transfer task is temporarily paused |
| Transfer Recovered | When the transfer is automatically recovered and resumed after an interruption or error |
| Device Connected | When a device is connected |
| Device Disconnected | When a device is disconnected |
Step 4. Save the Settings#
After completing the input, click Add to save the integration.
Checklist#
- ✔ The API Key has been entered.
- ✔ The Region has been selected.
- ✔ The events to monitor have been selected.
Verify the Integration#
Verify that the settings are working correctly.
Step 1. Trigger a Test Event#
Run an actual transfer task or trigger one of the selected events.
Step 2. Check Opsgenie#
Check whether an alert has been created in Alerts in Opsgenie.
Checklist#
- ✔ An alert has been created in Opsgenie.
- ✔ The triggered event was delivered successfully.
Setup Complete#
Once the settings are saved, the integration is applied.
After that, an alert is automatically created in Opsgenie whenever the selected events occur.
Troubleshooting#
| Issue | Checklist |
|---|---|
| An alert is not created | Check whether the API Key and Region are correct and whether there are leading or trailing spaces or missing characters. |
| Integration does not work | Check whether the API Integration is in the Turn on state. |
| An authentication or permission error occurs | Check whether the key used is an API Key issued by the API Integration. (Keys from API Key Management cannot be used.) |
| Region does not match | Check whether the Region of the Opsgenie instance matches the Region in the product settings. |
| Connection fails | Check whether the Opsgenie API endpoint (443) for the selected Region is allowed by the firewall or proxy. |