Documentation

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

Projects / Create

Operation Information

Creates a Project record in a Teamwork account.

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

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 Teamwork in the Type pick list;
  • Give the Teamwork KeySafe key a Title (this is the name / identifier for the Teamwork 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
API Token string API Token
Instance ID string ID of your Teamwork instance
Instance Region Code string Populate with the instance region code (for example: eu if your instance is hosted in Europe). Leave blank if not defined.

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

Input Parameters

Display Name ID Type Description Required Supported Values
Name of the Project name string Project Name Yes None provided
Description description string Description of the Project No None provided
Start Date startDate string Date the Project should start, format: YYYYMMDD No None provided
End Date endDate string Date the Project should end, format: YYYYMMDD No None provided
Company companyId string ID of the company, if the company already exists No None provided
New Company Name newCompany string The name of the new company, should the company not already exist No None provided
Category category-id string ID of the category to create the project against No None provided
Harvest Timers Enabled harvest-timers-enabled boolean Should the Harvest Timers be enabled No None provided
Tags tags string Project tags - comma seperated list No None provided
Reply By Email Enabled replyByEmailEnabled boolean Reply By Email Enabled No None provided
Privacy Enabled privacyEnabled boolean Privacy Enabled No None provided

Output Parameters

Display Name ID Type Description
ID id string Project ID
Status status string Project Status
In This Document