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

  • Article
  • 3 minutes to read

Operation Information

Update an Incident on 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 id string The Incident ID Yes None provided
Incident Title name string The Incident title No None provided
Incident Status status string The Incident Status No scheduled, investigating, verifying, identified, monotoring, resolved, completed
Incident Status impactOverride string Overrides the calculated imapct of an incident No none, maintenance, minor, major, critical
Incident Description body string The Incident Description No None provided
Incident Scheduled Date scheduled_for string The Incident Scheduled Date. Please use the folloowing format (YYYY-MM-DDTHH:MM:SS:000Z) No None provided
Incident Scheduled Until scheduled_until string The Incident Scheduled End Date. Please use the folloowing format (YYYY-MM-DDTHH:MM:SS:000Z) No None provided
Send Incident Reminders Before The Scheduled Start Date scheduled_reminder_prior boolean Controls whether to remind subscribers prior to scheduled incidents. No None provided
Automatically Move Incident To Maintenance Status auto_transition_to_maintenance_state boolean None provided No None provided
Automatically Move Incident To Operational Status auto_transition_to_operational_state boolean None provided No None provided
Automatically Change Incident To In Progress When Scheduled scheduled_auto_in_progress boolean None provided No None provided
Automatically Move Incident To Complete Status scheduled_auto_completed boolean None provided No None provided
Add a Component addComponent boolean Leave false if you would like to remove a component No None provided
Affected Components components array The Components affected by the Incident No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Freshstatus API
Status status string The API response status
Incident ID id string The ID of the incident
Incident Title name string The incident title
Incident Status incidentStatus string The Status of the Incident
Incident Updated Date updatedAt string The date the incident was last updated.
Link to the Incident shortLink string None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document