8000 Merge pull request #371 from Hacker0x01/martijnrusschen-patch-15 · niccelon/docs.hackerone.com@d70f3de · GitHub
[go: up one dir, main page]

Skip to content

Commit d70f3de

Browse files
Merge pull request Hacker0x01#371 from Hacker0x01/martijnrusschen-patch-15
Update documentation to properly reflect ability to provide custom tables
2 parents 1dca1a7 + 39dd756 commit d70f3de

File tree

2 files changed

+18
-9
lines changed

2 files changed

+18
-9
lines changed
49.1 KB
Loading

docs/programs/servicenow-integration.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ path: "/programs/servicenow-integration.html"
44
id: "programs/servicenow-integration"
55
---
66

7-
HackerOne offers a bi-directional ServiceNow integration that enables you to synchronize your HackerOne reports to ServiceNow incidents and vice versa, from ServiceNow to HackerOne. This integration enables your development and security teams to stay aligned as it also contributes to a better workflow of remediating security vulnerabilities by minimizing the manual back and forth between ServiceNow and HackerOne.
7+
HackerOne offers a bi-directional ServiceNow integration that enables you to synchronize your HackerOne reports to ServiceNow and vice versa, from ServiceNow to HackerOne. This integration enables your development and security teams to stay aligned as it also contributes to a better workflow of remediating security vulnerabilities by minimizing the manual back and forth between ServiceNow and HackerOne.
8+
9+
You can use this integration with different ServiceNow tables. The guide below uses the `incident` table that's used in the ServiceNow's [Incident Management](https://docs.servicenow.com/bundle/quebec-it-service-management/page/product/incident-management/concept/c_IncidentManagement.html) product. IF you're using the ServiceNow's [Security Incident Response](https://docs.servicenow.com/bundle/quebec-security-management/page/product/security-incident-response/reference/sir-landing-page.html) product, you can use the following table name: `sn_si_incident`. Alternatively, we support custom tables as well for full flexibility.
810

911
> **Note:** This integration is only available to Enterprise programs.
1012
@@ -87,6 +89,7 @@ HTTP Method | POST
8789
function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
8890
// Retrieve the incident with the passed in sys_id
8991
var sys_id = request.body.data.sys_id;
92+
// Create a new record for the table you want to use (in our example `incident`)
9093
var incident = new GlideRecord('incident');
9194
incident.get(sys_id);
9295
// Add comment to incident item
@@ -146,21 +149,27 @@ Field | Details
146149
ServiceNow Instance URL | Enter the full URL to your ServiceNow instance, for example it could be: https://my-instance.service-now.com/
147150
Client ID & Client secret | Enter the `Client ID` and `Client secret` from step 4 in [Configure OAuth](#configure-oauth)
148151

149-
5. Configure data mapping from HackerOne reports to ServiceNow incidents. This uses the API of both systems to retrieve fields that are allowed to be used for these objects. For example, you could map the HackerOne report title to the ServiceNow incident short description.
152+
5. Provide the name of the escalation table. By default, the integration uses the ServiceNow `incident` table. If you want to use a a different or a custom table, please enter the table in the field below. If you prefer to use Security Incidents instead, you can use the following table name: `sn_si_incident`.
150153

151-
![servicenow-18](./images/servicenow-18.png)
154+
![servicenow-27](./images/servicenow-27.png)
152155

153156
6. Click **Next**.
154157

155-
7. Enter your ServiceNow New Comment endpoint that was configured earlier in the **ServiceNow “Add Comment” endpoint** field. This should be a combination of the URL to your instance and the Resource Path found in the Scripted REST API object in ServiceNow.
158+
7. Configure data mapping from HackerOne reports to ServiceNow incidents. This uses the API of both systems to retrieve fields that are allowed to be used for these objects. For example, you could map the HackerOne report title to the ServiceNow incident short description.
159+
160+
![servicenow-18](./images/servicenow-18.png)
161+
162+
8. Click **Next**.
163+
164+
9. Enter your ServiceNow New Comment endpoint that was configured earlier in the **ServiceNow “Add Comment” endpoint** field. This should be a combination of the URL to your instance and the Resource Path found in the Scripted REST API object in ServiceNow.
156165

157166
![servicenow-19](./images/servicenow-19.png)
158167

159168
![servicenow-20](./images/servicenow-20.png)
160169

161-
8. Click **Next**.
162-
9. Copy the public listener URL in the configuration wizard.
163-
10. Click **Enable** to enable the integration.
170+
10. Click **Next**.
171+
11. Copy the public listener URL in the configuration wizard.
172+
12. Click **Enable** to enable the integration.
164173

165174
![servicenow-22](./images/servicenow-22.png)
166175

@@ -226,7 +235,7 @@ Name | Add Comment
226235
Table | Journal Entry [sys\_journal\_field]
227236
Advanced | Make sure the box is checked
228237

229-
14. Enter these values for these fields on the **When to run** tab:
238+
14. Enter these values for these fields on the **When to run** tab. In this example, we use the `incident` table, if you use a different escalation table use that name here instead of `incident`.
230239

231240
Field | Value
232241
----- | ------
@@ -294,7 +303,7 @@ Content-Type | application/json
294303
7. Click **Submit**.
295304
8. Navigate to **System Definition > Business Rules**.
296305
9. Click **New** to create a new business rule.
297-
10. Enter these values for these fields on the **When to run** tab:
306+
10. Enter these values for these fields on the **When to run** tab. In this example, we use the `incident` table, if you use a different escalation table use that name here instead of `incident`.:
298307

299308
Field | Value
300309
----- | -----

0 commit comments

Comments
 (0)
0