Shortcut Integration
Integrating with Shortcut
Integrating Shortcut into Jit enables you to efficiently assign security-related stories from Jit directly to Engineering and Security teams. Learn more here.
Integration steps
- Step 1: Creating an API token in your Shortcut account.
- Step 2: Assigning a secret to the API token in Jit.
- Step 3: Adding the secret's name and other fields to the jit-integration.yml file in the Jit centralized repo.
Step 1: Creating the API token
-
Login to your Shortcut account
-
Go to Settings > API Tokens.
- Choose a Token Name. We recommend
Jit_token
. - Click Generate Token.
- Copy the generated token displayed on the screen to the clipboard.
- Choose a Token Name. We recommend
Learn more in Shourtcut documentation.
Step 2: Assigning a secret to the API token
-
In the Jit platform, go to Settings and click Secrets.
-
Click Create new secret to add the API token. We recommend naming the secret -
shorcut_token
.
Learn more about Secrets.
Step 3: Creating the integration
-
In the Jit platform, go to Integrations and scroll to the Shortcut tile.
-
Click Integrate as-code to display the jit-integration.yml file in your centralized Jit repo.
-
Paste the following Shorcut integration-structure in the file.
shortcut:
`shortcut_integration_name`:
auth:
api_token: ${{ jit_secrets.`secret_name` }}
preferences:
project_id: `shortcut_project_id`
- Update the
keys
using the following information:
Key | Value |
---|---|
shortcut_integration_name | Give a name for this specific integration, it can be your Shortcut workspace name, e.g.,Engineering . |
secret_name | The secret name defined in Step 2, e.g., shortcut_token . |
shortcut_project_id | The project ID can be found in the URL of your Shortcut workspace: `https://app.shortcut.com/example/project/ProjectID/project_name |
For example:
shortcut:
Engineering:
auth:
api_token: ${{ secrets.shortcut_token }}
preferences:
Project_id: "engineering"
Updated 3 months ago