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 / Create

  • Article
  • 3 minutes to read

Operation Information

Create 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
Message message string The alert Message Yes None provided
Alias alias string Client-defined identifier of the alert, that is also the key element of Alert De-Duplication. No None provided
Description description string Description field of the alert that is generally used to provide a detailed information about the alert No None provided
Responders responders array Teams, users, escalations and/or schedules that the alert will be routed to send notifications No None provided
Visible To visibleTo array Teams and/or Users that the alert will be visible to No None provided
Actions actions array Custom actions that will be available for the alert No None provided
Tags tags array Tags of the alert No None provided
Custom Properties details array Map of key-value pairs to use as custom properties of the alert No None provided
Entity entity string Entity field of the alert that is generally used to specify which domain alert is related to No None provided
Source source string Source field of the alert. Default value is IP address of the incoming request No None provided
Priority priority string Priority level of the alert No P1, P2, P3, P4, P5
User user string Display name of the request owner No None provided
Note note string Additional note that will be added while creating the alert No None provided

Output Parameters

Display Name ID Type Description
Status status string Integration Status (ok or failed)
Error errors string Any error returned from the integration
Result result string The Result of the Alert Create request
Alias alias string The Alert Alias
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document