Integrating with Shortcut
Integrating FireHydrant with Shortcut enables you to create and sync incidents and action items created in FireHydrant with tickets (stories) in Shortcut.
Note: To configure FireHydrant’s Shortcut integration requires someone with a Shortcut owner role and a user with a FireHydrant owner role. FireHydrant recommends creating the Shortcut integration using a generic owner account Shortcut user to prevent potential problems arising from a Shortcut owner’s departure and subsequent account decommissioning.
To get started:
- Go to your Shortcut workspace. Navigate to Settings > API Tokens.
- On the API Tokens page, provide a name for the API token that will be generated (for example, "FireHydrant Integration").
- Copy the token generated by Shortcut.
- In the left nav in FireHydrant, click Integrations. Click the Shortcut tile.
- On the next page, click Install App.
- On the setup page, provide the API token that you generated in Shortcut.
To set up the integration as bi-directional, you can configure a webhook with Shortcut.
To get started:
- In the FireHydrant left nav, click ** Integrations**.
- Click the Shortcut integration card. From the Shortcut integration page, copy the webhook URL to your clipboard.
- In Shortcut, navigate to Integrations > Webhooks.
- Paste the URL you copied from FireHydrant into the Payload URL section and click Add New Webhook.
FireHydrant supports Shortcut field mapping on a per-project basis. You'll need to configure each Shortcut project you want to be available for Shortcut incident and action item ticket creation to define the field mappings.
- From the Shortcut integration settings in FireHydrant, locate Projects.
- For each Shortcut project you want to be accessible within FireHydrant, configure the project settings. These settings define how FireHydrant fields and statuses should be mapped to Shortcut tickets.
- Save the settings.
Note: To avoid unexpected problems, before you delete a configured Shortcut project, ensure that you have accounted for any Runbook steps and linked incidents and action items that reference the project.
To remove a configured Shortcut project from the integration, go to the Shortcut integration settings. Under Projects click Edit next to the project you wish to remove, then select Delete Permanently. Confirm the action.
Next configure a default project for your organization. This will act as a fallback in the event that a FireHydrant Shortcut ticket creation request request cannot communicate with the specified Jira project. To set a default project go to Organization > Account Overview. From the Account Overview page, choose to Edit the Organization section. On the Default project for tickets entry select a default project, then click Save organization.
If in the future you disconnect this integration, you will need to reconfigure the default project if you decide to reenable it.
In order to trigger a Shortcut issue creation from a new incident, you'll need to add a Runbook step and specify the Shortcut project destination.
From the Runbook step menu navigate to Shortcut and select Create a Shortcut Issue. Select the Shortcut project destination from the configured project list, and optionally adjust the default populated fields.