Table of contents
Shortcut Setup
WorkSights connects to Shortcut using an API token from your Shortcut workspace. There is no OAuth for Shortcut. Setup takes a few minutes.
For an overview of how Shortcut activity appears in WorkSights, see Shortcut Integration Overview.
Connecting Shortcut
Step 1: Get an API Token from Shortcut
- In Shortcut, go to Settings → API Tokens
- Create a new token
An admin-level token lets WorkSights register a webhook for near-real-time updates. A standard-level token also works — WorkSights falls back to checking for changes on an hourly cycle instead. Neither is a degraded setup; choose whichever token level you're comfortable issuing.
Step 2: Connect in WorkSights
- Go to Services in the top navigation
- Find Shortcut in the list and click Connect
- Paste your API token into the token field
- Click Connect
WorkSights validates the token before completing the connection.
If you used an admin-level token, WorkSights registers a webhook in your Shortcut workspace. Shortcut will send an email to your workspace admin confirming a Webhook Integration was added — this is expected and named after whoever's token was used, not WorkSights.
Step 3: User Mapping
WorkSights imports your Shortcut workspace members and matches them to WorkSights users by email address. Disabled members and bot or automation accounts are skipped automatically.
Open the Users tab to review mappings. For any member that didn't map automatically, select the correct WorkSights user from the dropdown.
Only mapped members will have their Shortcut activity attributed on the timeline.
What Happens Next
Once connected and users are mapped, WorkSights begins receiving story and comment activity from Shortcut. With an admin-level token, this arrives near-real-time via webhook. With a standard-level token, activity is picked up on an hourly cycle instead.
Only activity that occurs after the integration is connected will appear. Historical stories and comments are not imported.
User mappings and connection settings can be reviewed and updated at any time from the integration page.