Integrate with Ghost Inspector

What does the integration offer?

Ghost Inspector sends webhook notifications on test executions. With Compass's Ghost Inspector integration, Compass 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 and Android push notifications, and escalates alerts until the alert is acknowledged or closed. It also attaches screenshot images from tests to the alert. Additionally, 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 Compass 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 Compass
Configure the integration in Ghost Inspector

Add a Ghost Inspector integration

In this release, only incoming integrations are fully supported in the Standard plan, at a team level. To use outgoing integrations or the outgoing part of bidirectional integrations, upgrade to a higher subscription plan. There may be restrictions on how you can create and apply integration rules as well.

You can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.

To add a Ghost Inspector integration in Compass, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Ghost Inspector”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
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.
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 Compass, complete the following steps:

In Ghost Inspector, create a new test suite and define a test in it if not done already.
Go to the settings of the test.
Go to Webhook Settings.
Paste the API URL copied previously from Compass into Add Webhook URL.
Select the plus icon.
Select Save.

Sample payload sent from Ghost Inspector to Compass Close

JSON

{
  "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
    }
  }
}

Compass parses the payload as follows:

JSON

{
  "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"
}