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 Big Panda.

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 Big Panda.

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 Big Panda in the Type pick list;
  • Give the Big Panda KeySafe key a Title (this is the name / identifier for the Big Panda 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
Orginisation Token string The Unique Token Associated With Your Big Panda Instance used to perform some Big Panda Operations.
API Key string The API Token Associated With The Desired Integratoin Within Big Panda, used to perform most Big Panda Operations.
Server string Please Enter 'Europe' if when creating your API Key you see the following in the URL 'https://eu-api.bigpanda.io', Otherwise Please Enter 'General'.
Environment ID string The Individual Environment ID this can be found within the URL of an Environment following 'https://a.bigpanda.io/v2/feed/'

Tip

The API Key and Org Token can be found within your personal details when you select 'integrations' from the headers. For the Server Details if you Alerts API endpoint contains eu-api.bigpanda please enter 'Europe'. Please visit the Big Panda Website for details on creating API Keys.

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 Big Panda account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
App Key appKey string The App Key Generated When You Create An Integration Within Big Panda Yes None provided
Status status string Status of the event. One of [ ok, critical, warning, acknowledged ] No ok, acknowledged, warning, critical
Host host string The Host That Alerts Will Be Held Against. Yes None provided
Description description string The Description Of The Alert Raised In Big Panda No None provided
Incident Identifier incidentIdentifier string A [unique identifier used to recognize if two events are related to each other.] Adding an incident_identifier into the payload will override the default value, and allows you to configure specific deduplication rules. No None provided
Primary Property primary_property string Define a specific event property to act as primary property for this payload. The defined event property must be included in the payload. If not, the primary property will be defined by any included default fields. If no primary property is included, the payload will be dropped. No None provided
Secondary Property secondary_property string Define a specific event property to act as secondary property for this payload. The defined event property must be included in the payload. If not, the secondary property will be defined by any included default fields. No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Big Panda API
Status Code status string The status of the operation: ok / failed
Alert ID createdItemID string The ID of the Alert You Just Created
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document