How can we help?
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!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
This automation allows you to create a new Story against a Project in Clubhouse.
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 Shortcut API Token.
The API Endpoint field is not required to be populated for this integration.
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 |
|---|---|---|---|---|---|
| Name of the Story | name |
string |
Name | Yes | None provided |
| Project ID | project_id |
string |
ID of the project to associate the story to | Yes | None provided |
| Comments | comments |
array |
Comments to add to the new Story | No | None provided |
| Deadline | deadline |
string |
The due date of the story, in the format: 2021-07-08T12:00:00 | No | None provided |
| Description | description |
string |
The description of the story | No | None provided |
| Epic ID | epic_id |
string |
The ID of the epic the story belongs to | No | None provided |
| Estimate | estimate |
number |
The numeric point estimate of the story | No | None provided |
| External ID | external_id |
string |
External ID | No | None provided |
| Group ID | group_id |
string |
The UUID of the group to associate with this story | No | None provided |
| Iteration ID | iteration_id |
string |
The ID of the iteration the story belongs to | No | None provided |
| Labels | labels |
array |
Comments to add to the new story | No | None provided |
| Owner IDs | owner_ids |
array |
An array of UUIDs of the owners of this story | No | None provided |
| Requested By ID | requested_by_id |
string |
The UUID of the member that requested the story | No | None provided |
| Story Type | story_type |
string |
The type of story (The type of story (feature, bug, chore)) | No | feature, bug, chore |
Output Parameters
| Display Name | ID | Type | Description |
|---|---|---|---|
| Story ID | id |
string |
Story ID |
| Automation Status | status |
string |
Automation Status |
| Error | error |
string |
Any error returned |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}