Last modified by DevOps-as-a-Service Operator on 2025/02/05 11:33

Show last authors
1 (% style="color:#172b4d" %)Jira Server bot can send information about new activities in Jira to a Webex space.
2
3 {{toc outline="true" style="none"/}}
4
5 = Add Jira Server bot to Webex =
6
7 {{info}}
8 ℹ The owner of the Webex space needs to provide the space URL to be linked with Jira.
9 {{/info}}
10
11 (% style="letter-spacing:0.0px" %)For the Webex space owner, the following steps are necessary to provide the required URL:
12
13 ~1. Create or select an existing space in Webex. In the //People //section click on **Add people**.
14
15 [[image:attach:image2021-11-1_10-58-18.png||queryparams="effects=drop-shadow" height="250" width="675"]]
16
17 2. Search for** Jira Server** in the search field below //Add people to this space//.
18
19 [[image:attach:image2021-11-1_10-59-49.png||queryparams="effects=drop-shadow" width="400"]]
20
21 3.  Click **Add **to add the bot to the selected space. (It might be strange to add a bot as a "person" but this step is necessary to receive messages from Jira).
22
23 [[image:attach:image2021-11-1_11-1-23.png||queryparams="effects=drop-shadow" width="400"]]
24
25 Once added, type "@Jira" and select "Jira Server", then add "<space> manage" and press Enter.
26
27 4. Click on the new(% style="letter-spacing:0.0px" %) message received from Jira Server.
28 [[image:attach:06.png||height="48"]]
29
30
31 ...the message will look like this:
32 [[image:attach:07.png||height="144" width="675"]]
33
34 Click on "Click Here".
35
36 5. A new browser window opens with this URL. Find the selected space and click **Add New Notification **then click next:
37
38 [[image:attach:image2021-11-4_11-50-25.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="800"]]
39
40 6. In the next screen select **Manual Webhook **then click Next:
41
42 [[image:attach:image2021-11-4_11-49-9.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="800"]]
43
44 7. Follow the instructions depending on your needs (and please provide these settings to us). Filtering will be also set in Jira's Webhook anyway.
45
46 [[image:attach:image2021-11-4_11-54-56.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="355" width="544"]]
47
48 8. Copy embed URL and provide us with the requested events for changes in Jira.
49
50 = Create Service Request to connect Jira with Jira Server Bot =
51
52 Create a Service Request at [[Service Desk DevOps-as-a-Service>>url:https://prd.sdc.t-systems.net/jira/servicedesk/customer/portal/3/create/36||shape="rect"]].
53
54 In the Service request the following information is necessary to be provided:
55
56 * the proper URL for webex,
57 * the project name
58 * the project key
59 * and the triggered events (project related changes) in Jira (see //Available events //below).
60
61 (% class="table-bordered" %)
62 (% class="active" %)|=(((
63 Field
64 )))|=(((
65 Value
66 )))
67 |=(((
68 Summary
69 )))|(((
70 Create Jira Server webhook for Webex
71 )))
72 |=(((
73 Component
74 )))|(((
75 Jira
76 )))
77 |=(((
78 Description
79 )))|(((
80 Please connect Jira Server webhook to Webex.
81
82 The necessary URL from Webex is: **<URL retrieved from Webex>**
83
84 The name of the Jira project to be connected with Webex is: **<PROJECT_NAME>**
85
86 The project key is: **<PROJECT_KEY>**
87
88 The project admin has approved this service-request.
89
90 Send events for:
91
92 * Issue created
93 * Version released, created
94 * Sprint updated, started, closed
95 )))
96
97 {{info}}
98 ⚠** Note**
99 It is strongly recommended to select only one project per Webex space. For connecting the project to Webex make sure that YOU have the approval of the project administrator before you raise such a service request.
100 {{/info}}
101
102 == Available events ==
103
104 In the Service-Request description you can specify what issue or project related changes you want to see tracked in your webex space. The following choices are supported:
105
106 === Issue related ===
107
108 * Comment (This will generate a lot of noise in your webex space. Therefore we don't recommend it.)
109 ** created
110 ** updated
111 ** deleted
112 * Issue link
113 ** created
114 ** deleted
115 * Issue
116 ** created
117 ** updated
118 ** deleted
119
120 === Project related ===
121
122 * Version
123 ** released
124 ** unreleased
125 ** created
126 ** moved
127 ** updated
128 ** merged
129 ** deleted
130
131 === Jira Sofware related ===
132
133 * Sprint
134 ** created
135 ** deleted
136 ** updated
137 ** started
138 ** closed
139
140 == Example screenshot ==
141
142 In the following example the provided URL is pasted ([[https:~~/~~/botworkflows.webex.com/embed/run/>>url:https://botworkflows.webex.com/embed/run/99602b31a||shape="rect"]]...) , the name of Jira project (//Test Project//), the project key (//TESTPROJECT//) and the selected events are included also.
143
144 [[image:attach:image2021-11-4_12-17-28.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="480" width="540"]]
145
146 = Next steps =
147
148 As soon as the service request has been resolved, Jira should send notifications about the selected project events to the webex space.