• Products
  • Get started
  • Documentation
  • Resources

Integrate with Ghost Inspector

The feature described in this article is currently rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

Ghost Inspector logo

What does the integration offer?

Ghost Inspector sends webhook notifications on test executions. With Jira Service Management's Ghost Inspector integration, Jira Service Management acts as a dispatcher for these alerts, determines the right people to notify based on on-call schedules– notifies via email, text messages (SMS), phone calls, and iPhone & Android push notifications, and escalates alerts until the alert is acknowledged or closed.

also attaches screenshot images from tests to the alert. Links to the images are also provided in the alert.

How does the integration work?

When a test fails in Ghost Inspector, an alert is created in Jira Service Management automatically through the integration.

Set up the integration

Ghost Inspector is an API-based integration. Setting it up involves the following steps:

  • Add a Ghost Inspector integration in Jira Service Management

  • Configure the integration in Ghost Inspector

Add a Ghost Inspector integration

If you're using the Free or Standard plan in Jira Service Management, you can only add this integration from your team’s operations page. To access the feature through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be on Premium or Enterprise plan.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management only assigns the alerts received through this integration to your team.

To add a Ghost Inspector integration in Jira Service Management, complete the following steps:

  1. Go to your team’s operations page.

  2. On the left navigation panel, select Integrations and then Add integration.

  3. Run a search and select “Ghost Inspector”.

  4. On the next screen, enter a name for the integration.

  5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

  6. Select Continue.
    The integration is saved at this point.

  7. Expand the Steps to configure the integration section and copy the API URL.
    You will use this URL while configuring the integration in Ghost Inspector later.

  8. Select Turn on integration.
    The rules you create for the integration will work only if you turn on the integration.

Configure the integration in Ghost Inspector

To configure the integration of Ghost Inspector with Jira Service Management, complete the following steps:

  1. In Ghost Inspector, create a new test suite and define a test in it if not done already.

  2. Go to the settings of the test.

  3. Go to Webhook Settings.

  4. Paste the API URL copied previously from Jira Service Management into Add Webhook URL.

  5. Select the plus icon.

  6. Select Save.

Sample payload sent from Ghost Inspector to Jira Service Management Close

JSON

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 { "type": "result", "data": { "__v": 0, "executionTime": 21641, "dateExecutionFinished": "2014-12-26T12:44:16.238Z", "endUrl": "https://www.jsm.com/alert/create", "dateExecutionStarted": "2014-12-26T12:43:54.597Z", "startUrl": "https://www.jsm.com/auth/login", "test": { "_id": "549d11f534fd04ab414f1bd7", "name": "Create Alert", "suite": "549d10e134fd04ab414f1bd6", "organization": "549c158c8eebf29b7976b7b8" }, "screenshotCompare": { "compareSmall": { "depth": 8, "format": "PNG", "oname": "549d580a52a9666f152ffb33-compare.png", "mtime": "2014-12-26T12:44:18.000Z", "ctime": "2014-12-26T12:44:18.000Z", "size": 27425, "path": "/screenshots/549d580a52a9666f152ffb33-compareSmall.png", "defaultUrl": "https://ghostinspector.s3.amazonaws.com/screenshots/549d580a52a9666f152ffb33-compareSmall.png", "dims": { "w": 320, "h": 240 } }, "compareOriginal": { "depth": 8, "format": "PNG", "oname": "549d580a52a9666f152ffb33-compare.png", "mtime": "2014-12-26T12:44:18.000Z", "ctime": "2014-12-26T12:44:18.000Z", "size": 41948, "path": "/screenshots/549d580a52a9666f152ffb33-compareOriginal.png", "defaultUrl": "${url}?", "dims": { "w": 1024, "h": 768 } } }, "screenshot": { "small": { "depth": 8, "format": "PNG", "oname": "549d580a52a9666f152ffb33.png", "mtime": "2014-12-26T12:44:17.000Z", "ctime": "2014-12-26T12:44:17.000Z", "size": 11532, "path": "/screenshots/549d580a52a9666f152ffb33-small.png", "defaultUrl": "https://ghostinspector.s3.amazonaws.com/screenshots/549d580a52a9666f152ffb33-small.png", "dims": { "w": 320, "h": 240 } }, "original": { "depth": 8, "format": "PNG", "oname": "549d580a52a9666f152ffb33.png", "mtime": "2014-12-26T12:44:16.000Z", "ctime": "2014-12-26T12:44:16.000Z", "size": 34474, "path": "/screenshots/549d580a52a9666f152ffb33-original.png", "defaultUrl": "${url}", "dims": { "w": 1024, "h": 768 } } }, "_id": "549d580a52a9666f152ffb33", "video": { "path": "/videos/549d580a52a9666f152ffb33.mp4", "url": "https://ghostinspector.s3.amazonaws.com/videos/549d580a52a9666f152ffb33.mp4", "dims": { "w": 1024, "h": 768 } }, "screenshotCompareDifference": 0.118959, "screenshotComparePassing": false, "passing": false, "console": [], "urls": [ "https://www.jsm.com/auth/login", "https://www.jsm.com/auth/signIn", "https://www.jsm.com/customer/welcome", "https://www.jsm.com/alert/index", "https://www.jsm.com/alert/create" ], "steps": [ { "target": "#login", "command": "click", "value": "", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:56.719Z", "_id": "549d580c52a9666f152ffb34", "passing": true, "optional": false, "private": false, "sequence": 0 }, { "target": "#login", "command": "assign", "value": "abc@gmail.com", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:57.897Z", "_id": "549d580d52a9666f152ffb35", "passing": true, "optional": false, "private": false, "sequence": 1 }, { "target": "#password", "command": "assign", "value": "123", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:58.518Z", "_id": "549d580e52a9666f152ffb36", "passing": true, "optional": false, "private": true, "sequence": 2 }, { "target": "#password", "command": "keypress", "value": "13", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:59.098Z", "_id": "549d580f52a9666f152ffb37", "passing": true, "optional": false, "private": false, "sequence": 3 }, { "target": "a[href=/alert/create] > .l.title", "command": "click", "value": "", "url": "https://www.jsm.com/alert/index", "dateExecuted": "2014-12-26T12:44:03.269Z", "_id": "549d581352a9666f152ffb38", "passing": true, "optional": false, "private": false, "sequence": 4 }, { "target": "#message", "command": "click", "value": "", "url": "https://www.jsm.com/alert/create", "dateExecuted": "2014-12-26T12:44:04.767Z", "_id": "549d581452a9666f152ffb39", "passing": true, "optional": false, "private": false, "sequence": 5 }, { "target": "#message", "command": "assign", "value": "asdasd", "url": "https://www.jsm.com/alert/create", "dateExecuted": "2014-12-26T12:44:05.569Z", "_id": "549d581552a9666f152ffb3a", "passing": true, "optional": false, "private": false, "sequence": 6 }, { "target": "input[type=subm]", "command": "click", "value": "", "url": "https://www.jsm.com/alert/create", "error": "Element not found", "dateExecuted": "2014-12-26T12:44:15.885Z", "_id": "549d581f52a9666f152ffb3b", "passing": false, "optional": false, "private": false, "sequence": 7 }, { "target": ".alerts > .alertrow.clearfix.row:nth-of-type(2) > div:nth-of-type(2) > a.message.unseen", "command": "assertTextPresent", "value": "asdasd", "_id": "549d581f52a9666f152ffb3c", "passing": null, "optional": false, "private": false, "sequence": 8 }, { "target": "a[href=/alert/create] > .l.title", "command": "assertTextPresent", "value": "New Alert", "_id": "549d581f52a9666f152ffb3d", "passing": null, "optional": false, "private": false, "sequence": 9 } ], "viewportSize": { "width": 1024, "height": 768 } } }

Jira Service Management parses the payload as follows:

JSON

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 { "passing": true, "screenshotComparePassing": false, "executionTime": 21641, "dateExecutionStarted": "2014-12-26T12:43:54.597Z", "startUrl": "https://www.jsm.com/auth/login", "testId": "549d11f534fd04ab414f1bd7", "testName": "Create Alert", "testSuite": "549d10e134fd04ab414f1bd6", "testOrganization": "549c158c8eebf29b7976b7b8", "steps": [ { "target": "#login", "command": "click", "value": "", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:56.719Z", "_id": "549d580c52a9666f152ffb34", "passing": true, "optional": false, "private": false, "sequence": 0 }, { "target": "#login", "command": "assign", "value": "abc@gmail.com", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:57.897Z", "_id": "549d580d52a9666f152ffb35", "passing": true, "optional": false, "private": false, "sequence": 1 }, { "target": "#password", "command": "assign", "value": "123", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:58.518Z", "_id": "549d580e52a9666f152ffb36", "passing": true, "optional": false, "private": true, "sequence": 2 }, { "target": "#password", "command": "keypress", "value": "13", "url": "https://www.jsm.com/auth/login", "dateExecuted": "2014-12-26T12:43:59.098Z", "_id": "549d580f52a9666f152ffb37", "passing": true, "optional": false, "private": false, "sequence": 3 }, { "target": "a[href=/alert/create] > .l.title", "command": "click", "value": "", "url": "https://www.jsm.com/alert/index", "dateExecuted": "2014-12-26T12:44:03.269Z", "_id": "549d581352a9666f152ffb38", "optional": false, "private": false, "sequence": 4 }, { "target": "#message", "command": "click", "value": "", "url": "https://www.jsm.com/alert/create", "dateExecuted": "2014-12-26T12:44:04.767Z", "_id": "549d581452a9666f152ffb39", "passing": true, "optional": false, "private": false, "sequence": 5 }, { "target": "#message", "command": "assign", "value": "asdasd", "url": "https://www.jsm.com/alert/create", "dateExecuted": "2014-12-26T12:44:05.569Z", "_id": "549d581552a9666f152ffb3a", "passing": true, "optional": false, "private": false, "sequence": 6 }, { "target": "input[type=subm]", "command": "click", "value": "", "url": "https://www.jsm.com/alert/create", "error": "Element not found", "dateExecuted": "2014-12-26T12:44:15.885Z", "_id": "549d581f52a9666f152ffb3b", "passing": false, "optional": false, "private": false, "sequence": 7 }, { "target": ".alerts > .alertrow.clearfix.row:nth-of-type(2) > div:nth-of-type(2) > a.message.unseen", "command": "assertTextPresent", "value": "asdasd", "_id": "549d581f52a9666f152ffb3c", "passing": null, "optional": false, "private": false, "sequence": 8 }, { "target": "a[href=/alert/create] > .l.title", "command": "assertTextPresent", "value": "New Alert", "_id": "549d581f52a9666f152ffb3d", "passing": null, "optional": false, "private": false, "sequence": 9 } ], "testUrl": "https://app.ghostinspector.com/results/549d11f534fd04ab414f1bd7", "screenshotUrl": "${url}", "screenshotCompareUrl": "https://ghostinspector.s3.amazonaws.com/screenshots/549d580a52a9666f152ffb33-compareSmall.png" }

 

 

 

Additional Help