Overview
Shortcut is a project management platform for software development teams. Persona’s Shortcut integration lets Workflows find, create, retrieve, and update stories and list Shortcut workflows and their states.
Integration features
The Shortcut integration supports five Workflow actions:
- List stories: Find stories by archive status, epic, iteration, label, story type, or Workflow state.
- List workflows: Return workflows and their states.
- Create story: Create a story with a name, description, and optional Workflow state.
- Retrieve story: Return one story by its public ID.
- Update story: Change the name or description of an existing story.
Setting up the Shortcut integration
Prerequisites
To connect Shortcut, you need:
- A Shortcut account and workspace.
- A Shortcut API token with read and write permissions.
- Permission to manage integrations in the Persona Dashboard.
Adding a Shortcut credential
- In Shortcut, navigate to Settings > My Account > API Tokens.
- Create an API token with read and write permissions, then copy it.
- In the Persona Dashboard, navigate to Integrations > Marketplace and select Shortcut.
- Click Add Credential and enter a nickname for the credential.
- Enter the Shortcut API token, then save the credential.
Using Shortcut in a Workflow
- Create a Workflow or open an existing one.
- Add an Action Step, then select Integrations.
- Select Shortcut and choose your saved credential.
- Choose an action and map data into its fields.
- Save and publish the Workflow.
Shortcut operations
List stories
Return stories matching one or more optional filters.
Optional fields
- Archived.
- Epic ID.
- Iteration ID.
- Label name.
- Story type.
- Workflow state ID.
List workflows
Return the workflows and states in the connected Shortcut workspace. This action has no required fields.
Create story
Create a story in the connected Shortcut workspace.
Required field
- Name.
Optional fields
- Description.
- Workflow state ID.
Retrieve story
Return one Shortcut story.
Required field
- Story public ID: The numeric ID shown in the story URL or returned by Create story.
Update story
Update an existing Shortcut story.
Required field
- Story public ID.
Optional fields
- Name.
- Description.
Plans Explained
Shortcut Integration by plan
| Startup Program | Essential Plan | Growth Plan | Enterprise Plan | |
|---|---|---|---|---|
| Shortcut Integration | Not Available | Not Available | Limited | Available |