Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Complex Types - buzzActivityType


This type is used to represent a an activity object.


Name Type Occurrence Description
activityType activityType Required The type of the activity.
actorInfo accountBasicDetailsType Required Person or object that posted this activity.
additionalCommentsCount xs:unsignedInt Optional
The number of additional comments that are available for this activity.
comment buzzCommentType Optional
Array (0/∞)
The comments posted to this activity.
content xs:string Optional The text content displayed for this activity.
extra xs:string Optional Used to store a JSON structure that represents a referenced resource or application-specific additional content.
fileAttachment serverFileAttachmentType Optional
Array (0/∞)
Information about the file attachment.
icon xs:anyURI Optional Icon that should be displayed against the post.
id xs:anyURI Required The unique resource name identifier for this activity.
language xs:language Required The language the content is written in.
likes xs:unsignedInt Required Indicates the number of people that like this activity.
location geoLocationType Optional The location associated with this activity.
objectRefUrn xs:anyURI Optional The URN of the object associated with this activity.
published xs:dateTime Required The activity verb.
read xs:boolean Required
Indicates that the person querying the activity stream has read this activity.
status activityStatusType Required The type of the activity.
stream_id xs:anyURI Optional The ID of the stream for which this activity belongs. This is only provided in the response to a query that includes activity records that belong to more than one activity stream.
stream_owner_ref xs:anyURI Required The owner reference for the activity stream this activity belongs to
stream_type activityStreamType Required The type of stream this activity belongs to.
thumbnailAccessToken xs:string Optional If the activity included embedded content, this access token will provide time-limited access to the thumbnail image for the content via WebDAV cafs_raw.
title xs:string Optional the title displayed for this activity.
titleNew xs:string Required The title displayed for this activity generated by the system.
type xs:string Optional User defined type of this activity.
updated xs:dateTime Optional Time when this activity was updated. An activity will be updated when any comment is posted to it
verb buzzActivityVerbType Required the activity verb.
visibility activityVisibilityType Optional The visibility the method invoker has on this activity.
youLike xs:boolean Required Indicates that the person querying the activity stream likes this activity.
In This Document