Skip to main content

Shortcut integration

Integration with Shortcut is based on stories. Each time a new issue is reported to Bugsee, we create a new story of type bug in the Shortcut project you mapped the application to.

info

Bugsee maps applications to Shortcut projects, so your workspace needs at least one. Shortcut no longer creates a project in new workspaces by default — if the application mapping step comes back empty, create a project in Shortcut first and reopen the wizard.

Authentication​

Supported authentication methods​

Personal token​

To proceed with this authentication type you need to obtain API token from Shortcut. Steps below will instruct you how to do that.

Navigate to your Shortcut and click on gear icon in the header to reveal the menu. Then click "Settings".

Reveal user menu

In "Settings" popup, go to "API Tokens" section. Provide desired name for your new token in "Token Name" field and click "Generate Token" to create new token.

Generate token

Note that when you generate a new token, the value will only be displayed once, so make sure to write it down.

Once you have the token, use it in Bugsee authentication wizard:

Enter token

Configuration​

There are no specific configuration steps for Shortcut. Refer to configuration section for description about generic steps.

Custom recipes​

Bugsee can accommodate all these customizations with the help of custom recipes. This section provides a few examples of using custom recipes specifically with Shortcut. For basic introduction, refer to custom recipe documentation.

Setting labels field​

By default Bugsee creates and updates Shortcut bugs with Bugsee issue labels. But labels list can be overridden inside your custom recipe. For example you can add some new label to existing ones:

function create(context) {
// ....

return {
// ...
labels: [...issue.labels, "My awesome label"]
};
}

function update(context, changes) {
const result = {};
// ...

if (changes.labels) {
result.labels = [...changes.labels.to, "My awesome label"];
}

return {
issue: {
custom: {}
},
changes: result
};
}
Found an issue, typo, or wrong statement on this page? Report it now →