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

Welcome

  • Article
  • 2 minutes to read

Welcome to the user guide for Hornbill Platform API. In this guide, you will learn everything you need to know about using our API to its full potential. Whether you are new to the Hornbill API or have been using it for a while, this guide will provide you with all the information you need to get started and make the most of what our platform has to offer.

The Hornbill API is designed to give you access to a broad range of Hornbill Platform and Application filters. Whether you need to perform simple automatons or complex integrations from other systems, our API has been designed with your needs in mind. With its industry-standards based design and flexible options, the Hornbill API is well documented, accessible, and easy to use.

In this guide, we will cover the basics of the Hornbill API, including how to discover and connect to your instance, authenticate and make some API calls. We will also dive into some of the more advanced features, such as working with file content, security and diagnostic features, to help you get the most out of the Hornbill API.

We have tried to make this guide as comprehensive and clear as possible, so you can easily find the information you need. If you have any questions or need additional help, our support team is always available to assist you.

So, let’s get started! With the help of this guide, you will soon be able to work with our APIs and make the most of Hornbill’s capabilities.

Who is this guide for

This guide is for anyone that needs to work with the Hornbill Platform and/or Application APIs in order to integrate and/or automate functions within Hornbill from other systems.

This guide is a technical guide and requires you to have at least a basic/fundamental working knowledge of the following developer-related subjects: -

How to use this guide

Hornbill has combined many years of experience with modern standards based technologies in order to create a powerful and flexible API system for its products. Although the components we used to create the Hornbill API are well defined and standards-based, you can think of the Hornbill API as a recipe that brings these components together an a way that is very familiar, yet unique to Hornbill. Before you use the Hornbill API for anything serious, you should read the complete API Guide in the order it is presented in the document index. The API Reference section will act as a reference to the services, APIs, and types as needed once you are working with the APIs.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document