Skip to content

Commit a5b896b

Browse files
committed
docs: update jira integration guide
1 parent f9074e5 commit a5b896b

File tree

1 file changed

+49
-25
lines changed

1 file changed

+49
-25
lines changed

docs/integrations/jira.md

Lines changed: 49 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,44 @@ This integration lets you manage feedback using the same tools for project manag
1010

1111
## Prerequisites
1212

13-
- A PushFeedback account. If you don’t have one, [sign up for free](https://app.pushfeedback.com/accounts/signup/).
14-
- A project created in your PushFeedback dashboard. If you haven’t created one yet, follow the steps in the [Quickstart](../quickstart.md#2-create-a-project) guide.
13+
Before you begin, ensure you have:
14+
- A PushFeedback account. If you don't have one, [sign up for free](https://app.pushfeedback.com/accounts/signup/).
15+
- A project created in your PushFeedback dashboard. If you haven't created one yet, follow the steps in the [Quickstart](../quickstart.md#2-create-a-project) guide.
1516
- A Jira workspace (Cloud or Data Center) with access to Automation options.
1617

1718
## 1. Configure Jira automations
1819

19-
To set up automations in Jira, follow these steps:
20+
This section guides you through setting up the automation rule in Jira that will receive feedback from PushFeedback.
21+
22+
### Create the automation rule
2023

2124
1. Go to **Project settings** in your Jira project.
2225
2. Navigate to **Automation** under **Project settings**.
2326
3. Click **Create rule**:
2427

2528
![Create rule with Jira](./images/jira-create-rule.png)
2629

27-
4. Choose the **Incoming webhook** trigger:
30+
### Configure the automation rule
2831

29-
![Configure incoming webhook with Jira](./images/jira-create-incoming-webhook.png)
32+
1. Choose the **Incoming webhook** trigger:
3033

31-
5. Select exclude this automation rule with **No issues from the webhook**:
34+
![Configure incoming webhook with Jira](./images/jira-create-incoming-webhook.png)
3235

33-
![Exclude automation](./images/jira-configure-webhook.png)
3436

35-
6. Copy the webhook URL and click **Next** – you'll need it in the following section.
37+
2. Click **Next**.
3638

37-
7. Create a **Then** component:
39+
3. Create a **Then** component:
3840

3941
![Create then component with Jira](./images/jira-then-action.png)
4042

41-
8. Configure the **Then** component to **Create issue**:
43+
4. Configure the **Then** component to **Create work item**:
4244

4345
![Create issue with Jira](./images/jira-create-issue.png)
4446

4547
:::tip
46-
If you dont see the **Create issue** component, ensure **All actions** is marked.
48+
If you don't see the **Create work item** component, ensure **All actions** is marked.
4749
:::
48-
49-
10. Configure the **Create issue** action as follows:
50+
5. Configure the **Create work item** action as follows:
5051

5152
![Configure issue with Jira](./images/jira-configure-issue.png)
5253

@@ -55,41 +56,64 @@ To set up automations in Jira, follow these steps:
5556
3. **Summary:** Set to ``{{webhookData.summary}}``.
5657
4. **Description:** Set to ``{{webhookData.description}}``.
5758

58-
11. Click **Next**.
59+
7. Click **Next**.
5960

60-
12. Click **Turn on rule**, set a name for your rule, and assign the necessary permissions:
61+
8. Click **Turn on rule**, set a name for your rule, and assign the necessary permissions:
6162

6263
![Turn on the rule](./images/jira-turn-on-rule.png)
6364

64-
## 2. Configure the webhook in PushFeedback
65+
### Get the incoming webhook details
6566

66-
To activate the Jira integration in PushFeedback, follow these steps:
67+
1. Click the **Incoming webhook**.
6768

68-
1. Open [app.pushfeedback.com](https://app.pushfeedback.com).
69+
2. On **Work criteria**, select **No work items from the webhook**:
6970

70-
2. Log in with your account credentials.
71+
![Exclude automation](./images/jira-configure-webhook.png)
7172

72-
3. Once in the dashboard, go to the **Projects** tab.
73+
3. Copy the webhook URL and secret - you'll need these in the following section.
7374

74-
4. Select the project you wish to configure.
75+
:::important
76+
Save both the webhook URL and secret in a secure location. You'll need them to configure PushFeedback.
77+
:::
7578

76-
5. In the top-right corner, click on the **Settings** button.
79+
4. Click **Update**.
80+
81+
## 2. Configure PushFeedback
82+
83+
Now that your Jira automation is set up, let's configure PushFeedback to send feedback to it.
7784

85+
1. Open [app.pushfeedback.com](https://app.pushfeedback.com).
86+
2. Log in with your account credentials.
87+
3. Once in the dashboard, go to the **Projects** tab.
88+
4. Select the project you wish to configure.
89+
5. In the top-right corner, click on the **Settings** button.
7890
6. Under **Integrations**, select **Jira**.
7991

80-
7. Add the URL of the Jira Automation endpoint obtained in the previous section:
92+
7. Configure the webhook settings:
8193

8294
![Jira integration](./images/jira-integration.png)
8395

96+
1. Paste the webhook URL you copied from Jira
97+
2. If your Jira project requires authentication:
98+
- Paste the webhook secret in the **Secret** field
99+
- The secret will be sent as an `X-Automation-Webhook-Token` header with each request
100+
84101
8. Save your changes by clicking **Save**.
85102

86103
## 3. Test the integration
87104

88-
To ensure the integration is working correctly, follow these steps:
105+
To ensure everything is working correctly:
89106

90-
1. Go to any webpage where youve implemented the feedback widget and submit a feedback entry.
107+
1. Go to any webpage where you've implemented the feedback widget and submit a feedback entry.
91108
2. Confirm the feedback appears on your specified Jira board as a new issue:
92109

93110
![Jira board](./images/jira-board.png)
94111

95112
3. Verify that all relevant details are correctly mapped and visible on the Jira issue.
113+
114+
## Troubleshooting
115+
116+
If the integration isn't working:
117+
- Double-check the webhook URL and secret in PushFeedback.
118+
- Verify the Jira automation rule is enabled.
119+
- Check the Jira audit log for any error messages.

0 commit comments

Comments
 (0)