Skip to main content

Shortcut

This page contains the setup guide and reference information for the Shortcut source connector.

Prerequisites​

To set up the shortcut source connector with Airbyte, you'll need to create your API tokens from theie settings page. Please visit https://app.shortcut.com/janfab/settings/account/api-tokens for getting your api_key.

Documentation reference:​

Visit https://developer.shortcut.com/api/rest/v3#Introduction for API documentation

Authentication setup​

Refer https://developer.shortcut.com/api/rest/v3#Authentication for more details.

Configuration​

InputTypeDescriptionDefault Value
api_key_2stringAPI Key.
start_datestringStart date.
querystringQuery. Query for searching as defined in https://help.shortcut.com/hc/en-us/articles/360000046646-Searching-in-Shortcut-Using-Search-Operatorstitle:Our first Epic

Streams​

Stream NamePrimary KeyPaginationSupports Full SyncSupports Incremental
search_epicsidDefaultPaginator✅✅
categoriesidNo pagination✅✅
categories_milestonesidNo pagination✅✅
categories_objectivesidNo pagination✅✅
custom-fieldsidNo pagination✅✅
epic-workflowidNo pagination✅✅
epicsidNo pagination✅✅
epics_commentsidNo pagination✅✅
epics_storiesidNo pagination✅✅
filesidNo pagination✅✅
groupsidNo pagination✅❌
groups_storiesidNo pagination✅✅
iterationsidNo pagination✅✅
iterations_storiesidNo pagination✅✅
labelsidNo pagination✅✅
memberidNo pagination✅❌
membersidNo pagination✅✅
milestonesidNo pagination✅✅
milestones_epicsidNo pagination✅✅
objectivesidNo pagination✅✅
objectives_epicsidNo pagination✅✅
workflowsidNo pagination✅✅
stories_commentsidNo pagination✅✅
story_historyidNo pagination✅✅

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
API Key
required
string
api_key_2
string
start_date
string
query

Changelog​

Expand to review
VersionDatePull RequestSubject
0.0.612026-09-2286795Update dependencies
0.0.602026-09-1586211Update dependencies
0.0.592026-09-0885655Update dependencies
0.0.582026-08-1884732Update dependencies
0.0.572026-08-1184115Update dependencies
0.0.562026-08-0483619Update dependencies
0.0.552026-07-2883080Update dependencies
0.0.542026-07-2182578Update dependencies
0.0.532026-07-1482002Update dependencies
0.0.522026-06-3081227Update dependencies
0.0.512026-06-2380637Update dependencies
0.0.502026-06-1680050Update dependencies
0.0.492026-06-0979487Update dependencies
0.0.482026-06-0278936Update dependencies
0.0.472026-04-2877420Update dependencies
0.0.462026-04-2176762Update dependencies
0.0.452026-03-2474600Update dependencies
0.0.442026-03-0374231Update dependencies
0.0.432026-02-1772725Update dependencies
0.0.422026-01-2071658Update dependencies
0.0.412025-12-1870703Update dependencies
0.0.402025-11-2570108Update dependencies
0.0.392025-11-1869486Update dependencies
0.0.382025-10-2968807Update dependencies
0.0.372025-10-2168232Update dependencies
0.0.362025-10-1467743Update dependencies
0.0.352025-10-0767439Update dependencies
0.0.342025-09-3066907Update dependencies
0.0.332025-09-2466258Update dependencies
0.0.322025-09-0965699Update dependencies
0.0.312025-08-2465392Update dependencies
0.0.302025-08-1664992Update dependencies
0.0.292025-08-0364471Update dependencies
0.0.282025-06-2862293Update dependencies
0.0.272025-06-2161821Update dependencies
0.0.262025-06-1461307Update dependencies
0.0.252025-05-2560582Update dependencies
0.0.242025-05-1060060Update dependencies
0.0.232025-05-0459632Update dependencies
0.0.222025-04-2758994Update dependencies
0.0.212025-04-1958444Update dependencies
0.0.202025-04-1258008Update dependencies
0.0.192025-04-0557413Update dependencies
0.0.182025-03-2956896Update dependencies
0.0.172025-03-2256248Update dependencies
0.0.162025-03-0855632Update dependencies
0.0.152025-03-0155079Update dependencies
0.0.142025-02-2254524Update dependencies
0.0.132025-02-1554072Update dependencies
0.0.122025-02-0853585Update dependencies
0.0.112025-02-0153110Update dependencies
0.0.102025-01-2552393Update dependencies
0.0.92025-01-1851998Update dependencies
0.0.82025-01-1151451Update dependencies
0.0.72024-12-2850759Update dependencies
0.0.62024-12-2150353Update dependencies
0.0.52024-12-1449788Update dependencies
0.0.42024-12-1249440Update dependencies
0.0.32024-12-1149120Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.0.22024-11-0447658Update dependencies
0.0.12024-09-0545176Initial release by @btkcodedev via Connector Builder