Shortcut
Overview
Pre-built tooling
✅ Authorization
| Tools | Status |
|---|---|
| Pre-built authorization (API Key) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | 🚫 |
| Expired credentials detection | ✅ |
✅ Read & write data
| Tools | Status |
|---|---|
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Tenklo on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) |
| Proxy requests | ✅ |
✅ Observability & data quality
| Tools | Status |
|---|---|
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
✅ Customization
| Tools | Status |
|---|---|
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: <48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) |
| Per-customer configurations | ✅ |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
create-category | Create a category. | Action | 🔗 Github |
create-custom-field | Create a workspace custom field. | Action | 🔗 Github |
create-epic-comment | Add a comment to an epic. | Action | 🔗 Github |
create-epic | Create an epic. | Action | 🔗 Github |
create-iteration | Create an iteration. | Action | 🔗 Github |
create-label | Create a label. | Action | 🔗 Github |
create-linked-file | Attach a URL-based linked file. Associate it with stories afterward via update-story's linked_file_ids. | Action | 🔗 Github |
create-milestone | Create an Objective. | Action | 🔗 Github |
create-story-comment | Add a comment to a story. | Action | 🔗 Github |
create-story-link | Link two stories with a relationship verb (blocks, duplicates, relates to). | Action | 🔗 Github |
create-story-task | Add a checklist task to a story | Action | 🔗 Github |
create-story | Create a story. | Action | 🔗 Github |
delete-category | Delete a category. | Action | 🔗 Github |
delete-custom-field | Delete a workspace custom field. | Action | 🔗 Github |
delete-epic | Delete an epic. | Action | 🔗 Github |
delete-iteration | Delete an iteration. | Action | 🔗 Github |
delete-label | Delete a label | Action | 🔗 Github |
delete-linked-file | Delete a linked file. | Action | 🔗 Github |
delete-milestone | Delete an Objective | Action | 🔗 Github |
delete-story-comment | Delete a comment from a story. | Action | 🔗 Github |
delete-story-link | Remove a link between two stories. | Action | 🔗 Github |
delete-story-task | Delete a task from a story. | Action | 🔗 Github |
delete-story | Delete a story. | Action | 🔗 Github |
get-current-member | Get the authenticated member and their workspace context. | Action | 🔗 Github |
get-epic | Retrieve a single epic. | Action | 🔗 Github |
get-story-task | Retrieve a single task on a story. | Action | 🔗 Github |
get-story | Retrieve a single story with its embedded comments, tasks, and links. | Action | 🔗 Github |
list-categories | List categories (used to group Objectives/Milestones). | Action | 🔗 Github |
list-custom-fields | List workspace custom fields available on stories. | Action | 🔗 Github |
list-epics | List epics. | Action | 🔗 Github |
list-groups | List groups (the modern Team concept). | Action | 🔗 Github |
list-iterations | List iterations (sprints). | Action | 🔗 Github |
list-labels | List labels. | Action | 🔗 Github |
list-linked-files | List linked (URL-based) files. | Action | 🔗 Github |
list-members | List workspace members. | Action | 🔗 Github |
list-milestones | List Objectives (called milestones in the Shortcut API). | Action | 🔗 Github |
list-projects | List projects — a deprecated, pre-Epics/Groups feature. | Action | 🔗 Github |
list-stories | Search/list stories with rich filters. | Action | 🔗 Github |
list-workflows | List story workflows and their states. | Action | 🔗 Github |
update-epic | Update an epic. | Action | 🔗 Github |
update-iteration | Update an iteration. | Action | 🔗 Github |
update-label | Update a label. | Action | 🔗 Github |
update-milestone | Update an Objective. | Action | 🔗 Github |
update-story-task | Update or complete a task on a story. | Action | 🔗 Github |
update-story | Update a story. | Action | 🔗 Github |
categories | Sync categories (used to group Objectives). | Sync | 🔗 Github |
custom-fields | Sync workspace custom field definitions. | Sync | 🔗 Github |
epics | Sync epics. | Sync | 🔗 Github |
groups | Sync groups. | Sync | 🔗 Github |
iterations | Sync iterations. | Sync | 🔗 Github |
labels | Sync labels. | Sync | 🔗 Github |
members | Sync workspace members. | Sync | 🔗 Github |
milestones | Sync Objectives (API resource name is milestone). | Sync | 🔗 Github |
projects | Sync projects (legacy feature). | Sync | 🔗 Github |
stories | Sync stories. | Sync | 🔗 Github |
workflows | Sync story workflows and their states. | Sync | 🔗 Github |
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ |
Setup guide
No setup guide yet.
Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
Useful links
Contribute useful links by editing this page
API gotchas
Contribute API gotchas by editing this page