Appearance

Shortcut ​

Want the overview first? See the Shortcut integration overview.

How to set up ​

Configuration is per-project in Ybug. To integrate your Ybug project with Shortcut, go to your dashboard and follow these simple steps:

1. Generate a Shortcut API token. In Shortcut, open Settings → API Tokens, create a new token, and copy it.

2. In Ybug, Go to the Integrations section in your project settings.

3. Click the On/Off switch in the Shortcut row, paste your Shortcut API token, and click Authenticate with Shortcut.

Ybug Shortcut authentication page with the Shortcut API token field

4. Choose the Shortcut workflow where new Stories should be created. Ybug will use the workflow's default state. Optionally choose a team, epic, owners, and labels, then click the Save settings button.

Ybug Shortcut integration settings form with workflow, team, epic, owners, and labels

From now on, Ybug will create a Shortcut Story for each new feedback report. The Story includes the report description, browser and device details, screenshot, screen recording, page URL, and a link back to the original Ybug report.

Shortcut Story created from a Ybug feedback report

Notes ​

  • Ybug creates Shortcut Stories with the Bug story type.
  • Shortcut Projects are not required. Ybug uses Shortcut Workflows and the selected workflow's default state.
  • If the selected workflow, team, epic, owner, or label changes in Shortcut, update the integration settings in Ybug.

Advanced settings ​

Click Advanced settings in the integration form to change how the created story looks.

Story title format — the default is [{{project.name}}] #{{report.id}} {{report.title}}, and you can compose your own from placeholders such as {{report.priority}} or {{report.user.email}}. See Title format for the full list.

Forwarded data — choose which details Ybug includes, from the source URL and the reporter to browser, screen size and custom user data. See Forwarded data for all the options.