Skip to main content
Server path: /shortcut-resources | Type: Application | PCID required: Yes

Tools

ToolDescription
shortcut_resources_create_docCreate Doc
shortcut_resources_create_entity_templateCreate Entity Template
shortcut_resources_create_generic_integrationCreate Generic Integration
shortcut_resources_create_linked_fileCreate Linked File
shortcut_resources_delete_docDelete Doc
shortcut_resources_delete_entity_templateDelete Entity Template
shortcut_resources_delete_fileDelete File
shortcut_resources_delete_generic_integrationDelete Generic Integration
shortcut_resources_delete_linked_fileDelete Linked File
shortcut_resources_disable_story_templatesDisable Story Templates
shortcut_resources_enable_story_templatesEnable Story Templates
shortcut_resources_get_current_member_infoGet Current Member Info
shortcut_resources_get_docGet Doc
shortcut_resources_get_entity_templateGet Entity Template
shortcut_resources_get_fileGet File
shortcut_resources_get_generic_integrationGet Generic Integration
shortcut_resources_get_linked_fileGet Linked File
shortcut_resources_get_memberGet Member
shortcut_resources_get_repositoryGet Repository
shortcut_resources_link_document_to_epicLink Document to Epic
shortcut_resources_list_docsList Docs
shortcut_resources_list_document_epicsList Document Epics
shortcut_resources_list_entity_templatesList Entity Templates
shortcut_resources_list_filesList Files
shortcut_resources_list_linked_filesList Linked Files
shortcut_resources_list_membersList Members
shortcut_resources_list_repositoriesList Repositories
shortcut_resources_unlink_document_from_epicUnlink Document from Epic
shortcut_resources_update_docUpdate Doc
shortcut_resources_update_entity_templateUpdate Entity Template
shortcut_resources_update_fileUpdate File
shortcut_resources_update_healthUpdate Health
shortcut_resources_update_linked_fileUpdate Linked File
shortcut_resources_upload_filesUpload Files

shortcut_resources_create_doc

Create Doc Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesThe content for the new document.
content_formatstringNoFormat 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.
titlestringYesThe title for the new document.

shortcut_resources_create_entity_template

Create Entity Template Parameters:
ParameterTypeRequiredDefaultDescription
author_idstringNoThe id of the user creating this template.
namestringYesThe name of the new entity template
story_contentsobjectYesA map of story attributes this template populates.

shortcut_resources_create_generic_integration

Create Generic Integration Parameters:
ParameterTypeRequiredDefaultDescription
secretstringNoThe secret value
webhook_urlstringYesWebhook Url

shortcut_resources_create_linked_file

Create Linked File Parameters:
ParameterTypeRequiredDefaultDescription
content_typestringNoThe content type of the image (e.g. txt/plain).
descriptionstringNoThe description of the file.
namestringYesThe name of the file.
sizeintegerNoThe filesize, if the integration provided it.
story_idintegerNoThe ID of the linked story.
thumbnail_urlstringNoThe URL of the thumbnail, if the integration provided it.
typestringYesThe integration type of the file (e.g. google, dropbox, box).
uploader_idstringNoThe UUID of the member that uploaded the file.
urlstringYesThe URL of linked file.

shortcut_resources_delete_doc

Delete Doc Parameters:
ParameterTypeRequiredDefaultDescription
doc-public-idstringYesThe Doc’s public ID
content_formatstringNoFormat of the content to return. Defaults to ‘markdown’. If ‘html’, includes HTML content in response.

shortcut_resources_delete_entity_template

Delete Entity Template Parameters:
ParameterTypeRequiredDefaultDescription
entity-template-public-idstringYesThe unique ID of the entity template.

shortcut_resources_delete_file

Delete File Parameters:
ParameterTypeRequiredDefaultDescription
file-public-idintegerYesThe File’s unique ID.

shortcut_resources_delete_generic_integration

Delete Generic Integration Parameters:
ParameterTypeRequiredDefaultDescription
integration-public-idintegerYesThe integration-public-id value

shortcut_resources_delete_linked_file

Delete Linked File Parameters:
ParameterTypeRequiredDefaultDescription
linked-file-public-idintegerYesThe unique identifier of the linked file.

shortcut_resources_disable_story_templates

Disable Story Templates

shortcut_resources_enable_story_templates

Enable Story Templates

shortcut_resources_get_current_member_info

Get Current Member Info

shortcut_resources_get_doc

Get Doc Parameters:
ParameterTypeRequiredDefaultDescription
doc-public-idstringYesThe Doc’s public ID
content_formatstringNoFormat of the content to return. Defaults to ‘markdown’. If ‘html’, includes HTML content in response.

shortcut_resources_get_entity_template

Get Entity Template Parameters:
ParameterTypeRequiredDefaultDescription
entity-template-public-idstringYesThe unique ID of the entity template.

shortcut_resources_get_file

Get File Parameters:
ParameterTypeRequiredDefaultDescription
file-public-idintegerYesThe File’s unique ID.

shortcut_resources_get_generic_integration

Get Generic Integration Parameters:
ParameterTypeRequiredDefaultDescription
integration-public-idintegerYesThe integration-public-id value

shortcut_resources_get_linked_file

Get Linked File Parameters:
ParameterTypeRequiredDefaultDescription
linked-file-public-idintegerYesThe unique identifier of the linked file.

shortcut_resources_get_member

Get Member Parameters:
ParameterTypeRequiredDefaultDescription
member-public-idstringYesThe Member’s unique ID.
org-public-idstringNoThe unique ID of the Organization to limit the lookup to.

shortcut_resources_get_repository

Get Repository Parameters:
ParameterTypeRequiredDefaultDescription
repo-public-idintegerYesThe unique ID of the Repository.

Link Document to Epic Parameters:
ParameterTypeRequiredDefaultDescription
doc-public-idstringYesThe public ID of the Document.
epic-public-idintegerYesThe public ID of the Epic.

shortcut_resources_list_docs

List Docs

shortcut_resources_list_document_epics

List Document Epics Parameters:
ParameterTypeRequiredDefaultDescription
doc-public-idstringYesThe public ID of the Document.

shortcut_resources_list_entity_templates

List Entity Templates

shortcut_resources_list_files

List Files

shortcut_resources_list_linked_files

List Linked Files

shortcut_resources_list_members

List Members Parameters:
ParameterTypeRequiredDefaultDescription
org-public-idstringNoThe unique ID of the Organization to limit the list to.
disabledbooleanNoFilter members by their disabled state. If true, return only disabled members. If false, return only enabled members.

shortcut_resources_list_repositories

List Repositories
Unlink Document from Epic Parameters:
ParameterTypeRequiredDefaultDescription
doc-public-idstringYesThe public ID of the Document.
epic-public-idintegerYesThe public ID of the Epic.

shortcut_resources_update_doc

Update Doc Parameters:
ParameterTypeRequiredDefaultDescription
doc-public-idstringYesThe Doc’s public ID
contentstringNoThe new content for the document.
content_formatstringNoFormat 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.
titlestringNoThe new title for the document

shortcut_resources_update_entity_template

Update Entity Template Parameters:
ParameterTypeRequiredDefaultDescription
entity-template-public-idstringYesThe unique ID of the template to be updated.
namestringNoThe updated template name.
story_contentsobjectNoUpdated attributes for the template to populate.

shortcut_resources_update_file

Update File Parameters:
ParameterTypeRequiredDefaultDescription
file-public-idintegerYesThe unique ID assigned to the file in Shortcut.
created_atstringNoThe time/date that the file was uploaded.
descriptionstringNoThe description of the file.
external_idstringNoAn additional ID that you may wish to assign to the file.
namestringNoThe name of the file.
updated_atstringNoThe time/date that the file was last updated.
uploader_idstringNoThe unique ID assigned to the Member who uploaded the file to Shortcut.

shortcut_resources_update_health

Update Health Parameters:
ParameterTypeRequiredDefaultDescription
health-public-idstringYesThe unique ID of the Health record.
statusstringNoThe health status of the Epic.
textstringNoThe description of the Health status.

shortcut_resources_update_linked_file

Update Linked File Parameters:
ParameterTypeRequiredDefaultDescription
linked-file-public-idintegerYesThe unique identifier of the linked file.
descriptionstringNoThe description of the file.
namestringNoThe name of the file.
sizeintegerNoThe filesize, if the integration provided it.
story_idintegerNoThe ID of the linked story.
thumbnail_urlstringNoThe URL of the thumbnail, if the integration provided it.
typestringNoThe integration type of the file (e.g. google, dropbox, box).
uploader_idstringNoThe UUID of the member that uploaded the file.
urlstringNoThe URL of linked file.

shortcut_resources_upload_files

Upload Files Parameters:
ParameterTypeRequiredDefaultDescription
file0stringYesA file upload. At least one is required.
file1stringNoOptional additional files.
file2stringNoOptional additional files.
file3stringNoOptional additional files.
story_idintegerNoThe story ID that these files will be associated with.