Module shortcut

ballerinax/shortcut Ballerina library

2.0.0

Overview

Shortcut is a project management platform for software teams that organizes work into stories, epics, iterations and objectives. The Shortcut REST API (version 3) gives programmatic access to that work.

The Shortcut connector lets Ballerina applications read and manage stories, epics, iterations, labels, groups, milestones, objectives, documents, workflows and workspace members, and search across them.

Key features

  • Create, update, search and delete stories, tasks, comments and story links
  • Plan work with epics, iterations, milestones, objectives and categories
  • Organize work with labels, groups, projects and custom fields
  • Read workspace members, workflows and repositories
  • Manage files, linked files, documents and entity templates

Setup guide

To use the Shortcut connector, you need a Shortcut workspace and an API token.

  1. Sign in to Shortcut.
  2. Open Settings and select API Tokens under your account.
  3. Enter a name for the token and click Generate Token.
  4. Copy the token and store it securely. It is shown only once.

Quickstart

To use the Shortcut connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Copy
import ballerina/io;
import ballerinax/shortcut;

Step 2: Instantiate a new connector

  1. Create a Config.toml file and configure the token obtained in the steps above:
Copy
shortcutToken = "<Shortcut API token>"
  1. Create a shortcut:ApiKeysConfig and initialize the connector with it.
Copy
configurable string shortcutToken = ?;

final shortcut:Client shortcutClient = check new ({shortcutToken});

Step 3: Invoke the connector operation

List the epics in the workspace

Copy
public function main() returns error? {
    shortcut:EpicSlim[] epics = check shortcutClient->listEpics();
    foreach shortcut:EpicSlim epic in epics {
        io:println(epic.id, ": ", epic.name);
    }
}

Step 4: Run the Ballerina application

Copy
bal run

Examples

The Shortcut connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

  1. Iteration story planning - Create an iteration, add a story to it and set its estimate.
  2. Epic progress report - Report story progress for every epic and search stories.

Import

import ballerinax/shortcut;Copy

Other versions

See more...

Metadata

Released date: 1 day ago

Version: 2.0.0

License: Apache-2.0


Security

Direct vulnerabilities: No known direct vulnerabilities

Indirect vulnerabilities: 

Checked on 2026-11-21 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes


Pull count

Total: 44

Current verison: 1


Weekly downloads


Source repository


Keywords

Vendor/Shortcut

Area/Productivity & Collaboration

Type/Connector


Contributors