@managed-api/opsgenie-sr-connect NPM

ScriptRunner Connect Managed API for Opsgenie

Managed API for Opsgenie is an API Client for Opsgenie by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

fetch
Alert
Incident
- addResponder
- closeIncident
- createIncident
- deleteIncident
- getIncident
- getIncidents
- getLogs
- getRequestStatus
- reopenIncident
- resolveIncident
- updateDescription
- updateMessage
- updatePriority
- Alert
  - getAssociatedAlerts
  - getResponderAlerts
- Details
  - addDetails
  - removeDetails
- Note
  - addNote
  - getNotes
- Tags
  - addTags
  - removeTags
- Timeline

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { OpsgenieApi } from '@managed-api/opsgenie-sr-connect';

export default async function() {
    const api = new OpsgenieApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

2.1.0

Removed non-empty body from HEAD requests.

2.0.0

Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

0.2.0

Added support for the following Alert methods:
- Acknowledge Alert that can be used as Alert.acknowledgeAlert or All.acknowledgeAlert.
- Add Responder to Alert that can be used as Alert.addResponder or All.addResponderToAlert.
- Add Team to Alert that can be used as Alert.addTeam or All.addTeamToAlert.
- Assign Alert that can be used as Alert.assignAlert or All.assignAlert.
- Close Alert that can be used as Alert.closeAlert or All.closeAlert.
- Count Alerts that can be used as Alert.countAlerts or All.countAlerts.
- Create Alert that can be used as Alert.createAlert or All.createAlert.
- Delete Alert that can be used as Alert.deleteAlert or All.deleteAlert.
- Escalate Alert to Next that can be used as Alert.escalateAlertToNext or All.escalateAlertToNext.
- Execute Custom Action that can be used as Alert.executeCustomAction or All.executeCustomAlertAction.
- Get Alert that can be used as Alert.getAlert or All.getAlert.
- List Alerts that can be used as Alert.getAlerts or All.getAlerts.
- List Alert Logs that can be used as Alert.getLogs or All.getAlertLogs.
- List Alert Recipients that can be used as Alert.getRecipient or All.getAlertRecipients.
- List Alert Recipients that can be used as Alert.getRequestStatus or All.getRequestStatusforAlert.
- Snooze Alert that can be used as Alert.snoozeAlert or All.snoozeAlert.
- Unacknowledge Alert that can be used as Alert.unacknowledgeAlert or All.unacknowledgeAlert.
- Update Alert Description that can be used as Alert.updateDescription or All.updateAlertDescription.
- Update Alert Message that can be used as Alert.updateMessage or All.updateAlertMessage.
- Update Alert Priority that can be used as Alert.updatePriority or All.updateIncidentPriority.
Added support for the following Alert.Attachment methods:
- Create Alert Attachment that can be used as Alert.Attachment.createAttachment or All.createAlertAttachment.
- Delete Alert Attachment that can be used as Alert.Attachment.deleteAttachment or All.deleteAlertAttachment.
- Get Alert Attachment that can be used as Alert.Attachment.getAttachment or All.getAlertAttachment.
- List Alert Attachments that can be used as Alert.Attachment.getAttachments or All.getAlertAttachments.
Added support for the following Alert.Details methods:
- Add Details (Custom Properties) to Alert that can be used as Alert.Details.addDetails or All.addDetailsToAlert.
- Remove Details (Custom Properties) from Alert that can be used as Alert.Details.removeDetails or All.removeDetailsFromAlert.
Added support for the following Alert.Note methods:
- Add Note to Alert that can be used as Alert.Note.addNote or All.addNoteToAlert.
- List Alert Notes that can be used as Alert.Note.getNote or All.getAlertNotes.
Added support for the following Alert.Saved.Search methods:
- Create a Saved Search that can be used as Alert.Saved.Search.createSavedSearch or All.createSavedSearchForAlert.
- Delete Saved Search that can be used as Alert.Saved.Search.deleteSavedSearch or All.deleteSavedSearchForAlert.
- Get Saved Search that can be used as Alert.Saved.Search.getSavedSearch or All.getSavedSearchForAlert.
- List Saved Searches that can be used as Alert.Saved.Search.getSavedSearches or All.getSavedSearchesForAlert.
- Update Saved Search that can be used as Alert.Saved.Search.updateSavedSearch or All.updateSavedSearchForAlert.
Added support for the following Alert.Tags methods:
- Add Tags to Alert that can be used as Alert.Tags.addTags or All.addTagsToAlert.
- Remove Tags from Alert that can be used as Alert.Tags.removeTags or All.removeTagsFromAlert.
Added support for the following Incident methods:
- Add Responder to Incident that can be used as Incident.addResponder or All.addResponderToIncident.
- Close Incident that can be used as Incident.closeIncident or All.closeIncident.
- Create Incident that can be used as Incident.createIncident or All.createIncident.
- Delete Incident that can be used as Incident.deleteIncident or All.deleteIncident.
- Get Incident that can be used as Incident.getIncident or All.getIncident.
- List Incidents that can be used as Incident.getIncidenst or All.getIncidents.
- List Incident Logs that can be used as Incident.getLogs or All.getIncidentLogs.
- Get Request Status that can be used as Incident.getRequestStatus or All.getRequestStatusForIncident.
- Reopen Incident that can be used as Incident.reopenIncident or All.reopenIncident.
- Resolve Incident that can be used as Incident.resolveIncident or All.resolveIncident.
- Update Incident Description that can be used as Incident.updateDescription or All.updateIncidentDescription.
- Update Incident Message that can be used as Incident.updateMessage or All.updateIncidentMessage.
- Update Incident Priority that can be used as Incident.updatePriority or All.updateIncidentPriority.
Added support for the following Incident.Alert methods:
- Get Associated Alerts that can be used as Incident.Alert.getAssociatedAlerts or All.getAssociatedAlertsForIncident.
- Get Responder Alerts that can be used as Incident.Alert.getResponderAlerts or All.getResponderAlertsForIncident.
Added support for the following Incident.Details methods:
- Add Details(Custom Properties) to Incident that can be used as Incident.Details.addDetails or All.addDetailsToIncident.
- Remove Details(Custom Properties) from Incident that can be used as Incident.Details.removeDetails or All.removeDetailsFromIncident.
Added support for the following Incident.Note methods:
- Add Note to Incident that can be used as Incident.Note.addNote or All.addNoteToIncident.
- List Incident Notes that can be used as Incident.Note.getNotes or All.getIncidentNotes.
Added support for the following Incident.Tags methods:
- Add Tags to Incident that can be used as Incident.Tags.addTags or All.addTagsToIncident.
- Remove Tags from Incident that can be used as Incident.Tags.removeTags or All.removeTagsFromIncident.
Added support for the following Incident.Timeline methods:
- Add Incident Timeline Entry that can be used as Incident.Timeline.addEntry or All.addIncidentTimelineEntry.
- Delete Incident Timeline Entry that can be used as Incident.Timeline.deleteEntry or All.deleteIncidentTimelineEntry.
- List Incident Timeline Entries that can be used as Incident.Timeline.getEntries or All.getIncidentTimelineEntries.
- Get Incident Timeline Entrys that can be used as Incident.Timeline.getEntry or All.getIncidentTimelineEntry.
- Hide Incident Timeline Entry that can be used as Incident.Timeline.hideEntry or All.hideIncidentTimelineEntry.
- Unhide Incident Timeline Entry that can be used as Incident.Timeline.unhideEntry or All.unhideIncidentTimelineEntry.
- Update Incident Timeline Entry that can be used as Incident.Timeline.updateEntry or All.updateIncidentTimelineEntry.