Reference · built on requestConnectorWork & ticket management

Shortcut

Stories, epics, iterations, workflow states, and comments from Shortcut workspaces through Shortcut's REST API v3 and outgoing webhooks.

About

Shortcut is a project management product for software teams. A workspace holds stories grouped into epics and iterations; each story sits in a workflow state and carries owners, labels, an estimate, a deadline, and custom fields. Shortcut's REST API v3 answers at https://api.app.shortcut.com/api/v3 and authenticates every request with a Shortcut-Token header.

Through Fibric, an operator searches stories, reads epics and iterations, receives outgoing webhook events when stories change, and proposes a workflow state move, an owner, or a comment. Each proposal waits for your approval, is applied once, and leaves a note of what moved and how to move it back.

This is a reference listing. It documents what Fibric would read from Shortcut and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Stories through GET /stories/{story-public-id}, and story search through GET /search/stories with query, page_size, detail, and next
  • Filtered story queries through POST /stories/search on fields such as workflow_state_id, owner_ids, iteration_id, epic_id, label_name, and updated_at_start
  • Epics and their stories through GET /epics and GET /epics/{epic-public-id}/stories
  • Iterations and their stories through GET /iterations and GET /iterations/{iteration-public-id}/stories
  • Workflows and their states through GET /workflows, and custom fields through GET /custom-fields
  • Comments on a story through GET /stories/{story-public-id}/comments
  • Outgoing webhook events with actions on story and epic entities, each carrying id, entity_type, action, name, and changes

Proposed actions

  • Target capability: propose moving a story through PUT /stories/{story-public-id} with workflow_state_id, owner_ids, iteration_id, or epic_id
  • Target capability: propose a comment through POST /stories/{story-public-id}/comments
  • Target capability: propose a new story through POST /stories, or several at once through POST /stories/bulk
  • Target capability: propose changing estimate, deadline, labels, or custom_fields on a story through PUT /stories/{story-public-id}

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Nudge a story that stopped moving

    The operator queries stories by workflow_state_id and updated_at_end and proposes a comment to the owners, or a move back to the backlog, for your approval.

    With Action Follow-up

  • File a story from a support ticket

    When a ticket needs engineering, the operator proposes a story with the ticket summary, the right epic_id, and a label, and puts the ticket URL in external_links.

    With Escalation Packet, Ticket Triage

  • Report the iteration at the weekly review

    The operator reads the iteration's stories and their workflow states and drafts the summary of what finished, what slipped, and what has no owner.

    With Weekly Review

Requirements

  • A Shortcut workspace and an API token from https://app.shortcut.com/settings/account/api-tokens
  • A publicly addressable URL entered in Webhook settings under Settings, Integrations, with a secret so events carry a Payload-Signature header
  • The workflow_state_id values of the workflow your team uses, read once through GET /workflows
Authentication
An API token created in Shortcut under Settings, API Tokens, sent on every request in the Shortcut-Token header.

Limits

  • Shortcut's REST API allows 200 requests per minute; requests over that limit are not processed and return 429 Too Many Requests
  • Search pages hold at most 250 results, and ordering can shift between pages, so the connector follows the next token rather than re-querying
  • Webhook payloads name the entity and the changed fields; the connector reads the full story through the API before proposing anything
  • The webhook reference documents no retry policy, so a missed delivery is recovered by a search on updated_at_start

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Shortcut ↗

Questions and answers

How does Shortcut announce story changes?
Through outgoing webhooks configured under Settings, Integrations. Each event carries an id, changed_at, member_id, an actions array with entity_type, action (create, update, or delete), name, and changes, plus a references array for related entities such as workflow states. A Payload-Signature header holds an HMAC-SHA-256 of the body keyed by your secret.
What is the rate limit?
200 requests per minute, per Shortcut's REST API reference. Requests over the limit are not processed and return 429 Too Many Requests. The connector spaces history loads under that ceiling and uses POST /stories/search filters such as updated_at_start to read only what changed.
Can stories be updated in bulk?
Yes. PUT /stories/bulk changes many stories in one request, and POST /stories/bulk creates many with the same fields as Create Story. The operator proposes bulk changes as one reviewable set, and the record lists each story id touched.
Ask about Shortcut

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.