Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Alerts / Get

  • Article
  • 2 minutes to read

Operation Information

Retrieves information about an Alert within OpsGenie. See the Alert API documentation for more information: https://docs.opsgenie.com/docs/alert-api.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type API Key.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint

Tip

The API Endpoint field should be populated with the region-specific API URL that your Opsgenie account resides in. For accounts hosted in the EU, this should be https://api.eu.opsgenie.com and everywhere else it should be https://api.opsgenie.com.

Details on creating Opsgenie API Keys can be found in the Opsgenie Documentation.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked API Key account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
ID/Alias id string The Alert ID/Alias Yes None provided
ID Type idType string Possible values are id, tiny and alias Yes ID, Tiny, Alias

Output Parameters

Display Name ID Type Description
Status status string Integration Status (ok or failed)
Error errors string Any error returned from the integration
Id id string None provided
Tiny Id tinyId string None provided
Alias alias string None provided
Message message string None provided
Alert Status alertStatus string None provided
Acknowledged acknowledged boolean None provided
Is Seen isSeen boolean None provided
Snoozed snoozed boolean None provided
Snoozed Until snoozedUntil string None provided
Count count number None provided
Last Occurred At lastOccurredAt string None provided
Created At createdAt string None provided
Updated At updatedAt string None provided
Source source string None provided
Owner owner string None provided
Priority priority string None provided
Acknowleged Time (in milliseconds) ackTime number None provided
Closed Time (in milliseconds) closeTime number None provided
Acknowledged Date & Time ackDateTime string None provided
Closed Date & Time closeDateTime string None provided
Acknowledged By acknowledgedBy string None provided
Closed By closedBy string None provided
Entity entity string None provided
Description description string None provided
Server Name serverName string None provided
Region region string None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document