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

Changelog

Expand to review
VersionDatePull RequestSubject
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
Was this page helpful?