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

Scheduled Maintenance / Create

  • Article
  • 4 minutes to read

Operation Information

Create a period of scheduled maintenance 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
Scheduled Maintenance Title title string The title for the period of scheduled maintenance Yes None provided
Scheduled Maintenance Description description string The description for the period of scheduled maintenance No None provided
Scheduled Maintenance Start Time startTime string The start time for the period of scheduled maintenance in the following format: YYYY-MM-DDTHH:MM:SSZ Yes None provided
Scheduled Maintenance End Time endTime string The end time for the period of scheduled maintenance in the following format: YYYY-MM-DDTHH:MM:SSZ No None provided
Private Period Of Scheduled Maintenance isPrivate boolean The privacy for the period of scheduled maintenance No None provided
Scheduled Maintenance Auto Start isAutoStart boolean Would you like the scheduled maintenance to auto start? No None provided
Scheduled Maintenance Auto End isAutoEnd boolean Would you like the scheduled maintenance to auto end? No None provided
Allow Scheduled Maintenance Notifications sendNotification boolean Would you like to send notifications for the period of scheduled maintenance No None provided
Receive Email On Start Of Scheduled Maintenance emailOnStart boolean Would you like to recieve emails at the start period of scheduled maintenance No None provided
Receive Email On Completed Period Of Scheduled Maintenance emailOnComplete boolean Would you like to recieve an email on completion of scheduled maintenance No None provided
Recieve An Email A Day Before Scheduled Maintenance emailDayBefore boolean Would you like to revieve an email the day before the period of scheduled maintenance No None provided
Recieve An Email A Hour Before Scheduled Maintenance emailHourBefore boolean Would you like to revieve an email the day before the period of scheduled maintenance No None provided
Incident Source ID source integer The ID of your incdient source, this can be found within fresh status. No None provided
Affected Components affected_components array Any affected components 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
Maintenance ID id integer The ID of the maintenance record
Maintenance Title title string The maintenance title
Maintenance Desscription description string The description of the selected maintenance
Maintenance Start Time startTime string The time that the maintenance record was logged
Maintenance End Time endTime string The time the maintenance record was resolved
Is The Incident Privacy Enabled isPrivate string The privacy settings of the maintenance record
Scheduled Maintenance Source source integer The notification settings of the maintenance record
Send Scheduled Maintenance Notifications sendNotification boolean The notification settings of the scheduled maitenance
Email On Start Of Scheduled Maintenance emailOnStart boolean The email notification settings of the scheduled maitenance
Email On Completion Of Scheduled Maintenance emailOnComplete boolean The email notification settings of the scheduled maitenance
Email The Day Before Scheduled Maintenance emailDayBefore boolean The email notification settings of the scheduled maitenance
Email The Hour Before Scheduled Maintenance emailHourBefore boolean The email notification settings of the scheduled maitenance
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document