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

Incidents / Get

  • Article
  • 2 minutes to read

Operation Information

Retrieves the details of on Incident from statuspage.

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 Atlassian Statuspage.

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 Atlassian Statuspage in the Type pick list;
  • Give the Atlassian Statuspage KeySafe key a Title (this is the name / identifier for the Atlassian Statuspage 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
API Key string The Atlassian Statuspage API Key

Tip

The API Endpoint field should be populated with the Statuspage API URL: https://api.statuspage.io.

Details on creating Statuspage API Keys can be found in the Statuspage 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 Atlassian Statuspage account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Page ID pageId string The Statuspage page id this can be found in the logged in url. For example: ‘https://manage.statuspage.io/pages/[YOUR PAGE ID]/notifications’ Yes None provided
Incident ID incidentId string The Incident ID Yes None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Freshstatus API
Incident Status status string The incident status
Incident ID id string The ID of the incident
Incident Title name string The incident title
Incident Creation Date createdAt string The date the incident was created on.
Incident Updated Date updatedAt string The date the incident was last updated.
Incident Impact impact string The impact incident
Incident Was Revoled On resolvedAt string None provided
Scheduled Incident Auto Completion scheduledAutoCompleted string None provided
Scheduled Incident Start Time scheduledAutoInProgress string None provided
Incident Reminder scheduledReminderPrior string None provided
Date of Incident Reminder scheduledReminderAt string None provided
Link to the Incident shortLink string None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document