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

Topics / Create Topic

  • Article
  • 2 minutes to read

Operation Information

This integration will create a new topic within an existing forum.

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

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 API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key 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
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint

Tip

The API Key field should be populated with a valid API Key for your Invision Community account. The API Endpoint field should be populated with the URL for your Invision Community server.

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 API Key account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Forum forumId number The Forum ID to create the topic within Yes None provided
Title title string The title of the new topic Yes None provided
Content content string The topic content - supports HTML tags for formatting Yes None provided
Author authorId number The topic author ID. If not set, will be created as guest No None provided
Prefix Tag prefix string The prefix tag No None provided
Tags tags array Topic Tags No None provided
Locked locked boolean Indicating if the topic should be locked No None provided
Hidden hiddenTopic string Indicating if the topic should be hidden No Unhidden, Hidden pending moderator approval, Hidden by a moderator
Pinned pinned boolean Indicating if the topic should be pinned No None provided
Featured featured boolean Indicating if the topic should be featured No None provided

Output Parameters

Display Name ID Type Description
Status status string Status of the request
Topic ID topicId string ID of the new Topic
Topic URL topicUrl string URL of the new Topic
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document