Shortcut

Shortcut is a project management platform for software teams, organizing work into stories, epics, iterations, objectives, and milestones. Its REST API v3 exposes these planning objects along with groups, members, labels, and custom fields, so teams can read project data into a warehouse or push new work items back into Shortcut. Nexla connects to the Shortcut API using an API token for authentication.

Power end-to-end data operations for your Shortcut API with Nexla. Our bi-directional Shortcut connector is purpose-built for Shortcut, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Shortcut or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Shortcut workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Shortcut credential, you need to generate an API token from your Shortcut account. Shortcut uses API token authentication for all API requests, with the token sent in the Shortcut-Token header.

To obtain your Shortcut API token, follow these steps:

1. Sign in to your Shortcut workspace at app.shortcut.com.

2. Navigate to your API tokens settings at app.shortcut.com/settings/account/api-tokens, or click your workspace icon and go to Settings > API Tokens.

3. Enter a name for the new token (for example, "Nexla Integration"), then click Generate Token.

4. Copy the generated token immediately and store it securely. The token is displayed only once and cannot be retrieved again after you leave the page.

An API token grants complete access to your Shortcut account, so keep it confidential. If a token is exposed publicly, Shortcut automatically invalidates it. You can revoke a token at any time from the same API Tokens settings page and generate a replacement. For more details, see the Shortcut REST API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Token	Yes	No	Shortcut API token, sent in the Shortcut-Token header.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Shortcut API token in the API Token field. This token is sent in the Shortcut-Token header to authenticate all requests to the Shortcut API and must be kept confidential.

   An API token grants complete access to your Shortcut account. If a token is compromised, revoke it in your Shortcut API Tokens settings and generate a new one.

   For more information about authentication and available endpoints, see the Shortcut REST API documentation.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Shortcut connector tile, then select the credential that will be used to connect to Shortcut, and click Next; or, create a new Shortcut credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Shortcut endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Groups

Retrieve groups. This endpoint template returns the groups (teams) defined in your Shortcut workspace.

[Rest API] List Groups Stories

Retrieve stories for a group. Provide the required Group ID parameter to identify the group whose stories should be retrieved.

[Rest API] List Member

Retrieve information about the authenticated member associated with the API token.

[Rest API] List Members

Retrieve members. This endpoint template returns the members belonging to your Shortcut workspace.

[Rest API] List Search Epics

Search for epics. This endpoint template returns epics matching a search query and paginates automatically through the result set.

[Rest API] List Categories

Retrieve categories. This endpoint template returns the categories defined in your Shortcut workspace.

[Rest API] List Categories Milestones

Retrieve milestones for a category. Provide the required Category ID parameter to identify the category whose milestones should be retrieved.

[Rest API] List Categories Objectives

Retrieve objectives for a category. Provide the required Category ID parameter to identify the category whose objectives should be retrieved.

[Rest API] List Custom Fields

Retrieve custom fields. This endpoint template returns the custom fields configured in your Shortcut workspace.

[Rest API] List Epic Workflow

Retrieve the epic workflow for the workspace, including its defined epic states.

[Rest API] List Epics

Retrieve epics. This endpoint template returns the epics defined in your Shortcut workspace.

[Rest API] List Epics Comments

Retrieve comments for an epic. Provide the required Epic ID parameter to identify the epic whose comments should be retrieved.

[Rest API] List Epics Stories

Retrieve stories for an epic. Provide the required Epic ID parameter to identify the epic whose stories should be retrieved.

[Rest API] List Files

Retrieve files. This endpoint template returns the files uploaded to your Shortcut workspace.

[Rest API] List Iterations

Retrieve iterations. This endpoint template returns the iterations (sprints) defined in your Shortcut workspace.

[Rest API] List Iterations Stories

Retrieve stories for an iteration. Provide the required Iteration ID parameter to identify the iteration whose stories should be retrieved.

[Rest API] List Labels

Retrieve labels. This endpoint template returns the labels defined in your Shortcut workspace.

[Rest API] List Milestones

Retrieve milestones. This endpoint template returns the milestones defined in your Shortcut workspace.

[Rest API] List Milestones Epics

Retrieve epics for a milestone. Provide the required Milestone ID parameter to identify the milestone whose epics should be retrieved.

[Rest API] List Objectives

Retrieve objectives. This endpoint template returns the objectives defined in your Shortcut workspace.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Shortcut data sources can also be manually configured to ingest data from any valid Shortcut REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Shortcut data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Shortcut destination, and select the Send to Destination option from the menu. Select the Shortcut connector from the list of available destination connectors, then select the credential that will be used to connect to Shortcut, and click Next; or, create a new Shortcut credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Shortcut endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Story

Create a new story in Shortcut. Each record from your Nexset is sent as a separate request to create a story, using the story fields present in the record body.

[Rest API] Update Story

Update an existing story by its public ID. Provide the required Story Public ID parameter to identify the story to update, and include the fields to change in the record body.

[Rest API] Create Epic

Create a new epic with customizable metadata. Each record from your Nexset is sent as a separate request to create an epic, using the epic fields present in the record body.

[Rest API] Update Epic

Update an existing epic by its public ID. Provide the required Epic Public ID parameter to identify the epic to update, and include the fields to change in the record body.

[Rest API] Create Iteration

Create a new iteration (sprint) in Shortcut. Each record from your Nexset is sent as a separate request to create an iteration, using the iteration fields present in the record body.

Manual configuration

Shortcut destinations can also be manually configured to send data to any valid Shortcut REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Shortcut APIs expect JSON format for create and update operations. For update operations, include the public ID of the object to be updated at the end of the endpoint URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Shortcut endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Shortcut endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.