Shortcut
Turn requests and orders into Shortcut work, and keep status in step across your tools.
46 ways to read, 26 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Shortcut, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create categoryApproval by rule
- Create docApproval by rule
- List categoriesRead
Example flow
- Shortcut · List categoriesDone
- Shortcut · Create categoryNeeds approval
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Shortcut.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Shortcut
- Shortcut's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect your own account when you are ready to go live.
For developers
Technical detail
Read and write Shortcut stories, epics, objectives, iterations, docs, comments, tasks, links, labels, categories and linked files; read workflows, teams, members and history.
Shortcut Software Company API docs- Source actions
- 46
- Destination actions
- 26
- Data types
- 24
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Categories4
- Create categoryDestinationNot retried automaticallyApproval before production
Creates an objective category.
- Get categorySource
A single category.
- List categoriesSource
Objective categories.
- Update categoryDestinationProvider duplicate protectionApproval before production
Renames or recolours a category.
Current member1
- Get token memberSource
The member the API token acts as.
Custom fields2
- Get custom fieldSource
A custom field definition and its enum values.
- List custom fieldsSource
Custom field definitions and their enum values.
Documents5
- Create docDestinationNot retried automaticallyApproval before production
Creates a Shortcut Doc from Markdown or HTML.
- Get docSource
A Shortcut Doc with its content as Markdown, or as HTML when requested.
- List docsSource
Shortcut Docs the token member can see (ID, title and link).
- Search docsSource
Docs whose title matches the text, optionally archived or created by the token member.
- Update docDestinationProvider duplicate protectionApproval before production
Replaces a doc's title or content.
Entity templates2
- Get story templateSource
A single story template.
- List story templatesSource
Story templates and the fields they pre-fill.
Epic comments4
- Add epic commentDestinationNot retried automaticallyApproval before production
Adds a Markdown comment to an epic, or a reply to an existing epic comment.
- Get epic commentSource
A single epic comment with its replies.
- List epic commentsSource
Threaded comments on an epic.
- Edit epic commentDestinationProvider duplicate protectionApproval before production
Replaces the text of an epic comment.
Epic workflow1
- Get epic workflowSource
The workspace epic workflow and its epic states, for mapping epic state IDs.
Epics5
- Create epicDestinationNot retried automaticallyApproval before production
Creates an epic.
- Get epicSource
A single epic.
- List epicsSource
Epics with state, owners, dates and story statistics.
- Search epicsSource
Epics matching a Shortcut search query, for example state:"in progress" team:Web.
- Update epicDestinationProvider duplicate protectionApproval before production
Updates supplied epic fields.
Files3
- Get fileSource
Metadata for one uploaded file.
- List filesSource
Uploaded file metadata and the stories they are attached to.
- Update file detailsDestinationProvider duplicate protectionApproval before production
Renames an uploaded file or changes its description or external ID.
Groups2
- Get teamSource
A single team (group).
- List teamsSource
Teams (groups) and their members.
Iterations5
- Create iterationDestinationNot retried automaticallyApproval before production
Creates an iteration.
- Get iterationSource
A single iteration.
- List iterationsSource
Iterations (sprints) with dates, status and teams.
- Search iterationsSource
Iterations matching a Shortcut search query.
- Update iterationDestinationProvider duplicate protectionApproval before production
Updates supplied iteration fields.
Key results2
- Get key resultSource
A key result of an objective with its observed and target values.
- Update key resultDestinationProvider duplicate protectionApproval before production
Records progress on a key result: its observed value, target or name (numbers, percentages or true/false).
Labels4
- Create labelDestinationNot retried automaticallyApproval before production
Creates a label.
- Get labelSource
A single label.
- List labelsSource
Workspace labels.
- Update labelDestinationProvider duplicate protectionApproval before production
Renames, recolours or archives a label.
Linked files4
- Link external fileDestinationNot retried automaticallyApproval before production
Links an externally hosted file, optionally to a story.
- Get linked fileSource
A single linked file.
- List linked filesSource
Externally hosted files (Google Drive, Dropbox, Box, OneDrive, URLs) linked to stories.
- Update linked fileDestinationProvider duplicate protectionApproval before production
Updates a linked file's name, link, description or story.
Members2
- Get memberSource
A single workspace member.
- List membersSource
Workspace members, for owner mapping.
Objectives5
- Create objectiveDestinationNot retried automaticallyApproval before production
Creates an objective.
- Get objectiveSource
A single objective.
- List objectivesSource
Objectives with state, categories and key results.
- Search objectivesSource
Objectives matching a Shortcut search query.
- Update objectiveDestinationProvider duplicate protectionApproval before production
Updates supplied objective fields, including state and categories.
Projects2
- Get projectSource
A single legacy project.
- List projectsSource
Legacy Shortcut projects with their workflow, team and story statistics.
Repositories1
- List repositoriesSource
VCS repositories connected to the workspace (GitHub, GitLab, Bitbucket).
Stories5
- Create storyDestinationNot retried automaticallyApproval before production
Creates a story with optional checklist tasks, labels and custom field values.
- Get storySource
A story with its tasks, comments, links and custom fields.
- List stories in an epic, iteration, label, project or parent storySource
All stories in an epic, an iteration, with a label, in a legacy project, or the sub-task stories of a parent story (provide one).
- Search storiesSourceIncremental
Stories matching a Shortcut search query, for example state:started team:Ops, optionally updated since a date.
- Update storyDestinationProvider duplicate protectionApproval before production
Updates supplied story fields, including workflow state, owners and iteration.
Story comments4
- Add story commentDestinationNot retried automaticallyApproval before production
Adds a Markdown comment to a story, optionally as a reply.
- Get story commentSource
A single story comment.
- List story commentsSource
Comments on a story.
- Edit story commentDestinationProvider duplicate protectionApproval before production
Replaces the text of a story comment.
Story history1
- List story historySource
The change log of a story: who changed which fields, and when.
Story links3
- Link storiesDestinationNot retried automaticallyApproval before production
Creates a dependency or relation: the subject story blocks, duplicates or relates to the object story.
- Get story linkSource
A single story dependency or relation.
- Update story linkDestinationProvider duplicate protectionApproval before production
Changes the relation or the stories of a story link.
Story tasks3
- Add story taskDestinationNot retried automaticallyApproval before production
Adds a checklist task to a story.
- Get story taskSource
A single checklist task.
- Update story taskDestinationProvider duplicate protectionApproval before production
Updates or completes a checklist task.
Workflows2
- Get workflowSource
A workflow with its states.
- List workflowsSource
Workflows and their states, for mapping workflow state IDs.
Access and limits
- Authentication
- Shortcut API token
- Plans and access
- All Shortcut plans. Tokens act as the member who created them, with that member's workspace access.
- Test environment
- Use a separate free or trial Shortcut workspace for testing.
- Rate limits
- 200 requests per minute per token; HTTP 429 when exceeded.
- Pagination
- Story, epic, iteration, objective and doc searches return a next path (up to 1,000 results); epics page with page/page_size; other lists are returned whole.
- Provider events
- Shortcut outgoing webhooks with a Payload-Signature HMAC. Flows run on demand, on a schedule, or when a scheduled check finds new or changed records.
Before you build a flow
- Story search returns at most the first 1,000 matches; narrow the query for larger sets.
- Custom field writes accept enum value IDs, the only custom field type Shortcut exposes.
- external_id is stored but not enforced as unique by Shortcut, so creates have no duplicate protection.
- File metadata is read; file uploads and downloads are not transferred.
- Searches for epics, iterations and objectives use Shortcut search operators in the query; only story search adds an updated-since filter, because Shortcut documents the updated: operator for stories.
- Docs are listed (title and link) and searched by title; full Markdown or HTML content is returned by Get doc.
- Story history returns the change log Shortcut keeps for one story; there is no workspace-wide history endpoint.
- Projects are Shortcut's legacy grouping and are read only here; teams, epics and objectives replace them.
- Intentionally excluded: every delete (stories, epics, comments, tasks, links, labels, categories, objectives, docs, files, iterations), bulk story deletes, team (group) creation and membership changes, member invitations and roles, enabling or disabling iterations and story templates, Slack thread unlinking, and webhook integration management.
- Deletes are not implemented.
Developer reference
- Create the Shortcut Software Company credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Shortcut, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/shortcut and the Connections API.