Documentation

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

Slack

Slack is a cloud communication and collaboration platform. Hornbill's integration with Slack enable you to manage channels, chats and users from Hornbill workflows.
This is a Premium Integration.

Cloud Automations

Channels

OperationDescription
Channel Archive Archives a Slack channel.
Channel Create Creates a Slack channel.
Channel Get Info Retrieves information about a Slack channel.
Channel Lookup Id Looks up a Slack channel ID by name.
Channel Update Updates the details about a Slack channel.
User Add to Channel Adds a user to a Slack channel.
User Remove from Channel Removes a user from a Slack channel.

Chat

OperationDescription
Delete Message Deletes a message from a Slack chat.
Post Message This method posts a message to a public channel, private channel, or direct message/IM channel.
Reply to Message Replies to a message in a Slack chat.
Update Message Updates a messahe in a Slack chat.

Groups

OperationDescription
Group Archive Archives a Slack group.
Group Close Closes a Slack group.
Group Create Creates a Slack group.
Group Get Info Retrieves information about a Slack group.
Group Lookup Id Looks up the ID of a Slack group by its name.
Group Update Updates a Slack group.
User Add to Group Adds a user to a Slack group.
User Remove from Group Removes a user from a Slack group.

Pins

OperationDescription
Pin Message Posts a slack message to a channel and pins that message
Pin Remove Remove one or multiple pins.

To remove a specific pins specify the timestamp of the pin. To remove all pins from a user specify the user name, to remove all pins in a channel leave both timestamp and username blank.

Reminders

OperationDescription
Reminder Add Creates a Slack reminder.
Reminder Complete Completes a Slack reminder.
Reminder Delete Deletes a Slack reminder.

Users

OperationDescription
Get User Info Retrieves information about a Slack user.
User Lookup Id Looks up the ID of a Slack user from their username.
In This Document