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

  • Article
  • 2 minutes to read

Operation Information

Creates an Incident in Freshstatus.

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

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 Freshstatus in the Type pick list;
  • Give the Freshstatus KeySafe key a Title (this is the name / identifier for the Freshstatus 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
Domain string The subdomain value for your Freshstatus account: https://subdomain.freshstatus.io
API Key string Freshstatus Account API Key

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

Input Parameters

Display Name ID Type Description Required Supported Values
Incident Title title string The incident title Yes None provided
Incident Description description string The incident description No None provided
Incident Start Time startTime string The incident start date in the following format: YYYY-MM-DDTHH:MM:SSZ No None provided
Incident End Time endTime string The incident end date in the following format: YYYY-MM-DDTHH:MM:SSZ No None provided
Incident Source ID source integer The ID of your incdient source, this can be found within fresh status. No None provided
Enable Incident Privacy isPrivate boolean Is The Incident Private No None provided
Enable Incident Notifictions sendNotfication boolean Enable Incident Notification Alerts No None provided
Affected Components affected_components array The Items you would like included in the invoice No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Freshstatus API
Status Code status string The status of the operation: ok / failed
Incident ID id integer The ID of the new incident
Incident Title title string The incident title
Incident Desscription description string The description of the selected incident
Incident Start Time startTime string The time that the incident was logged
Incident End Time endTime string The time the incident was resolved
Is The Incident Privacy Enabled private string The privacy settings of the incident
Does The Incident Send Notifications notificationsEnabled string The notification settings of the incident
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document