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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

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