/shortcut-resources | Type: Application | PCID required: Yes
Tools
shortcut_resources_create_doc
Create Doc Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content | string | Yes | — | The content for the new document. |
content_format | string | No | — | Format of the content being sent. Defaults to ‘html’. If ‘markdown’, content will be converted to HTML for storage. Storage is always HTML; this parameter just tells us what format you’re sending. |
title | string | Yes | — | The title for the new document. |
shortcut_resources_create_entity_template
Create Entity Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
author_id | string | No | — | The id of the user creating this template. |
name | string | Yes | — | The name of the new entity template |
story_contents | object | Yes | — | A map of story attributes this template populates. |
shortcut_resources_create_generic_integration
Create Generic Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
secret | string | No | — | The secret value |
webhook_url | string | Yes | — | Webhook Url |
shortcut_resources_create_linked_file
Create Linked File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content_type | string | No | — | The content type of the image (e.g. txt/plain). |
description | string | No | — | The description of the file. |
name | string | Yes | — | The name of the file. |
size | integer | No | — | The filesize, if the integration provided it. |
story_id | integer | No | — | The ID of the linked story. |
thumbnail_url | string | No | — | The URL of the thumbnail, if the integration provided it. |
type | string | Yes | — | The integration type of the file (e.g. google, dropbox, box). |
uploader_id | string | No | — | The UUID of the member that uploaded the file. |
url | string | Yes | — | The URL of linked file. |
shortcut_resources_delete_doc
Delete Doc Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
doc-public-id | string | Yes | — | The Doc’s public ID |
content_format | string | No | — | Format of the content to return. Defaults to ‘markdown’. If ‘html’, includes HTML content in response. |
shortcut_resources_delete_entity_template
Delete Entity Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entity-template-public-id | string | Yes | — | The unique ID of the entity template. |
shortcut_resources_delete_file
Delete File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file-public-id | integer | Yes | — | The File’s unique ID. |
shortcut_resources_delete_generic_integration
Delete Generic Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integration-public-id | integer | Yes | — | The integration-public-id value |
shortcut_resources_delete_linked_file
Delete Linked File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linked-file-public-id | integer | Yes | — | The unique identifier of the linked file. |
shortcut_resources_disable_story_templates
Disable Story Templatesshortcut_resources_enable_story_templates
Enable Story Templatesshortcut_resources_get_current_member_info
Get Current Member Infoshortcut_resources_get_doc
Get Doc Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
doc-public-id | string | Yes | — | The Doc’s public ID |
content_format | string | No | — | Format of the content to return. Defaults to ‘markdown’. If ‘html’, includes HTML content in response. |
shortcut_resources_get_entity_template
Get Entity Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entity-template-public-id | string | Yes | — | The unique ID of the entity template. |
shortcut_resources_get_file
Get File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file-public-id | integer | Yes | — | The File’s unique ID. |
shortcut_resources_get_generic_integration
Get Generic Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integration-public-id | integer | Yes | — | The integration-public-id value |
shortcut_resources_get_linked_file
Get Linked File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linked-file-public-id | integer | Yes | — | The unique identifier of the linked file. |
shortcut_resources_get_member
Get Member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
member-public-id | string | Yes | — | The Member’s unique ID. |
org-public-id | string | No | — | The unique ID of the Organization to limit the lookup to. |
shortcut_resources_get_repository
Get Repository Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
repo-public-id | integer | Yes | — | The unique ID of the Repository. |
shortcut_resources_link_document_to_epic
Link Document to Epic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
doc-public-id | string | Yes | — | The public ID of the Document. |
epic-public-id | integer | Yes | — | The public ID of the Epic. |
shortcut_resources_list_docs
List Docsshortcut_resources_list_document_epics
List Document Epics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
doc-public-id | string | Yes | — | The public ID of the Document. |
shortcut_resources_list_entity_templates
List Entity Templatesshortcut_resources_list_files
List Filesshortcut_resources_list_linked_files
List Linked Filesshortcut_resources_list_members
List Members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-public-id | string | No | — | The unique ID of the Organization to limit the list to. |
disabled | boolean | No | — | Filter members by their disabled state. If true, return only disabled members. If false, return only enabled members. |
shortcut_resources_list_repositories
List Repositoriesshortcut_resources_unlink_document_from_epic
Unlink Document from Epic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
doc-public-id | string | Yes | — | The public ID of the Document. |
epic-public-id | integer | Yes | — | The public ID of the Epic. |
shortcut_resources_update_doc
Update Doc Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
doc-public-id | string | Yes | — | The Doc’s public ID |
content | string | No | — | The new content for the document. |
content_format | string | No | — | Format of content. For input: specifies format of provided content (defaults to ‘html’). For output: controls response format - ‘markdown’ (default) or ‘html’ to include HTML content. |
title | string | No | — | The new title for the document |
shortcut_resources_update_entity_template
Update Entity Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entity-template-public-id | string | Yes | — | The unique ID of the template to be updated. |
name | string | No | — | The updated template name. |
story_contents | object | No | — | Updated attributes for the template to populate. |
shortcut_resources_update_file
Update File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file-public-id | integer | Yes | — | The unique ID assigned to the file in Shortcut. |
created_at | string | No | — | The time/date that the file was uploaded. |
description | string | No | — | The description of the file. |
external_id | string | No | — | An additional ID that you may wish to assign to the file. |
name | string | No | — | The name of the file. |
updated_at | string | No | — | The time/date that the file was last updated. |
uploader_id | string | No | — | The unique ID assigned to the Member who uploaded the file to Shortcut. |
shortcut_resources_update_health
Update Health Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
health-public-id | string | Yes | — | The unique ID of the Health record. |
status | string | No | — | The health status of the Epic. |
text | string | No | — | The description of the Health status. |
shortcut_resources_update_linked_file
Update Linked File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
linked-file-public-id | integer | Yes | — | The unique identifier of the linked file. |
description | string | No | — | The description of the file. |
name | string | No | — | The name of the file. |
size | integer | No | — | The filesize, if the integration provided it. |
story_id | integer | No | — | The ID of the linked story. |
thumbnail_url | string | No | — | The URL of the thumbnail, if the integration provided it. |
type | string | No | — | The integration type of the file (e.g. google, dropbox, box). |
uploader_id | string | No | — | The UUID of the member that uploaded the file. |
url | string | No | — | The URL of linked file. |
shortcut_resources_upload_files
Upload Files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file0 | string | Yes | — | A file upload. At least one is required. |
file1 | string | No | — | Optional additional files. |
file2 | string | No | — | Optional additional files. |
file3 | string | No | — | Optional additional files. |
story_id | integer | No | — | The story ID that these files will be associated with. |

