Shortcut Integration

Efficient website feedback with Shortcut in a few simple steps.

Joe Scanlon avatar
Written by Joe Scanlon
Updated over a week ago

Collect website feedback as new issues directly in your Shortcut projects. With our 2-way synchronization, your issue status, fields, and comments are always in sync.


Set up a Shortcut Integration

Add a project

To get started, go to the Marker.io dashboard and Create a project.

Complete the project form by entering a :

  • Project name

  • The website where you wish to collect feedback

  • Select your integration

  • Select the space within your integration where you wish to receive your feedback

If this is your first time connecting, you must authorize marker.io to use your Shortcut account by grabbing an API key.

Configure forms

We fetch your native Shortcut fields into your widget form. You can show/hide any fields and preset fields. For example, set the default Type as "Bug" and allow your reporters to change that as they see fit.

Note: Marker.io members report through the Member form, while Guests and Public Reporters report via the Guest form. More on that in our User Roles Guide.

Install widget

The last step is to install the website widget. We have many options for installing our widget and recommend our manual JavaScript install in most cases.

Alternatively, install the widget via WordPress plugin, NPM package, or send a request to your developer in one click.

Visit your website, refresh and check that the widget appears.


How it works

Collect feedback

Reporters can submit their feedback directly to your Shortcut project without leaving their website. Their feedback will automatically include detail-rich technical data.

Let’s say the Contact Us button is broken on the About Us page. The reporter clicks on the widget and is presented with a screenshot and a feedback form to complete.

The screenshot can be annotated, and the feedback form can be as simple or as complex as you wish. We recommend keeping the feedback form as simple as possible for your non-technical reporters.

Review issues

In your Shortcut project, you see the feedback arrive with the screenshot and automatically captured technical data, including:

  • Page URL

  • Browser

  • Screen size

  • Operating system

Communicate with reporters

The "Contact via Marker.io" link opens the Feedback Page, where you can communicate with your reporters. All conversations will be synced with Shortcut.

Synchronize Status

Once you update an issue status to “done” within Shortcut, this will update the Marker.io status to resolved and notify the reporter via email that the issue is complete.


FAQs

Is Marker.io secure?

We take your data and the security of our systems very seriously, using the most advanced security to connect with your account. See the latest version of our security policy at: https://marker.io/security.

What permissions are required to integrate with Shortcut?

Admin permissions are required on the Shortcut project you wish to connect with.

I can't connect my Shortcut account to Marker.io

Any issues setting this up? Try the following:

  1. Log in to your Shortcut account

    Log in to Shortcut in a second tab. This ensures that your password and username do not require additional security verification. When logged in to Shortcut, return to Marker.io and try connecting your Shortcut account.

  2. Reset your password in Shortcut

    Try setting a new password in your Shortcut account and see if that helps to resolve the issue.

  3. Still not working?

    Please start a chat conversation with us in the lower right corner of your screen.

How do I configure Shortcut webhooks?

To have the status of your issues in Marker.io be updated automatically when changing the state of a story in Shortcut, you first need to add the Marker.io webhook in your Shortcut workspace.

  • Access your Shortcut integrations here.

    Alternatively, click on Integrations in your user menu:

  • Select Webhooks.

  • Add New Webhook.

  • Copy the webhook Payload URL and secret info from your Marker.io project.

  • Paste your info back in Shortcut and save.

  • Within your Marker.io project, enable the auto-update, and click Save.

Your issue in Marker.io will be marked as Resolved once they reach a Done state in Shortcut.

How do I use Marker.io with more than one Shortcut workspace?

As you can only have one personal account per integration in Marker.io and Shortcut API tokens are scoped to workspaces, it is currently only possible to use a personal account with a single Shortcut workspace.

However, there is a workaround to use Marker.io to create stories in different Shortcut workspaces.

Let's assume you have connected a personal account in Marker.io using a Shortcut API token generated within Workspace A. You can create Marker.io projects linked to projects from Workspace A and report to them.

To setup Marker.io with Workspace B, follow these simple steps:

Step 1: Go to Workspace B in Shortcut and generate a new API token.

Step 2: In Marker.io, delete your personal Shortcut account.
Step 3: Add your new personal Shortcut account in Marker.io using the new API token from step 1.
Step 4: Create a new project by selecting a project from Workspace B.

You can now report to the new Workspace B project. Of course, the caveat is that the team account name will be used when mentioning the reporter, but this is the only way to work with Marker.io and multiple Shortcut workspaces.

You may have to set up the projects from Workspace A to use the main Integration account to keep reporting to them since you have removed the initial personal account linked to that workspace:

Nothing changes for guest reporters since you have to use a team account to allow your guests to report anyway.


Invite your team to collaborate on a dedicated Shortcut project today with Marker.io, where anyone can report bugs and feedback in seconds. We have many advanced features for you to explore. See Marker.io Academy, which we continuously update with our latest features.

Did this answer your question?