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
  • 4 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 The returned Alert ID
Tiny Id tinyId string The returned Tiny ID of the Alert record
Alias alias string The Alias returned from the Alert
Message message string The Message returned from the Alert
Alert Status alertStatus string The Status of the Alert at the time of the request
Acknowledged acknowledged boolean A true or false statement stating if the Alert has been Acknowledged
Is Seen isSeen boolean A true or false statement stating if the Alert has been opened
Snoozed snoozed boolean A true or false statement stating if the Alert has been snoozed
Snoozed Until snoozedUntil string The time stamp of when this Alert was snoozed until in the format of YYYY-MM-DDTHH:MM:SS.MSSZ
Count count number The count field shows how many times this alert with this specific alias has been created.
Last Occurred At lastOccurredAt string The last time an Alert with a similar alias to the one retrieved was created
Created At createdAt string The time stamp the Alert that was retrieved was created at
Updated At updatedAt string The time stamp the Alert that was retrieved was last updated at
Source source string The original source of the Alert retrieved
Owner owner string The Owner’s email address of the Alert retrieved
Priority priority string The Priority of the Alert retrieved
Acknowleged Time (in milliseconds) ackTime number The date time of the Alert being Acknowleged converted into milliseconds
Closed Time (in milliseconds) closeTime number The date time of the Alert being Closed converted into miliseconds
Acknowledged Date & Time ackDateTime string The Date Time of the retrieved Alert being Acknowledged
Closed Date & Time closeDateTime string The Date Time of the retrieved Alert being Closed
Acknowledged By acknowledgedBy string The Email Address of the User who Acknowledged the retrieved Alert
Closed By closedBy string The User that Closed the Alert retrieved
Entity entity string The Domain that the Alert retrieved is related to
Description description string Any further information that describes the Alert retrieved
Server Name serverName string The Name of the Server hosting the Alert retrieved
Region region string The Region that the Alert retrieved was created in
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document