logo

CALLGOOSE

Ghost Inspector

Overview

This document provides a detailed guide to integrating Ghost Inspector with Callgoose SQIBS for real-time Incident Management, Incident Auto Remediation, Event-Driven Automation, and other automation purposes. The integration enables automatic creation, updating, and resolution of incidents in Callgoose SQIBS based on alerts triggered in Ghost Inspector. The guide includes steps for setting up alerts in Ghost Inspector, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

  • Ghost Inspector Account: Access to Ghost Inspector for creating alerts and managing notifications.
  • Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
  • Webhook/API Endpoint: Available in Callgoose SQIBS to receive alerts from Ghost Inspector.

1. Obtain API Token and Endpoint Details

To integrate with Callgoose SQIBS, you first need to obtain an API token and find the API endpoint details.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with Ghost Inspector notifications for troubleshooting purposes.

  • Enable Debugging:
  • You can update the debug value when adding or updating an API token.
  • When API tracking is enabled, logs are stored in the API log section for your review. The debugging option will automatically disable after 48 hours.
  • When API tracking is turned off, no logs are saved in the API log.
  • Using API Log for Troubleshooting:
  • The API log provides detailed information on all API calls made to Callgoose SQIBS.
  • You can check the JSON values in each API log entry for troubleshooting purposes.
  • Use the information in the API log to create or refine API filters to ensure incidents are created correctly based on the API payloads received.
  • Callgoose SQIBS creates incidents according to your API filter configuration, giving you full control over how alerts from different services trigger incidents and alerts for your support team or automation processes.

3. Configuring Ghost Inspector to Send JSON Payloads

Follow these steps to set up monitoring, alerts, and webhook integrations in Ghost Inspector, ensuring that the JSON payloads generated match the required format for Callgoose SQIBS.

3.1 Setting Up Ghost Inspector

  • Log into Ghost Inspector
  • Access Ghost Inspector and log in using your account credentials.
  • Create a New Test Suite (if not already created)
  • In the Ghost Inspector dashboard, select Create New Suite.
  • Provide a descriptive name for the suite relevant to your tests.
  • Click Save to create the suite.
  • Create a New Test
  • Open the newly created suite from the dashboard.
  • Click on New Test within the suite.
  • Fill in:
  • Test Name: Choose a name to describe the test function.
  • Starting URL: Enter the URL where the test should start.
  • Click Create to initiate the test.
  • Add and Configure Test Steps
  • Within the test, click on Add Step.
  • Configure each step as per the requirements. Options include:
  • Capture Screenshot
  • Execute JavaScript
  • Interact with Page Elements
  • After adding each step, click Save Changes to preserve your configuration.

3.2 Setting Up Webhook in Ghost Inspector

  • Set Up Webhook for Notifications
  • In the test’s settings, navigate to Settings > Notifications.
  • Locate the Webhooks section and select Yes to enable webhooks.
  • Click Add Webhook and enter the following:
  • Webhook URL: Paste the endpoint URL provided by Callgoose SQIBS. This URL may vary based on authentication or specific parameters. Refer to the Callgoose SQIBS API Documentation to confirm the exact endpoint format.
  • Click Save Changes to apply the webhook.

3.3 Finalizing and Testing

  • Validate the Integration:
  • Trigger the alert condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
  • Resolve the alert to ensure the resolved state payload is also correctly sent and processed.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the Ghost Inspector alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Ghost Inspector

Alert Triggered (passing: "false")

json

{
  "type": "result",
  "data": {
    "user": {
      "_id": "****",
      "name": "Robert D"
    },
    "viewportSize": {
      "width": 1280,
      "height": 800
    },
    "_id": "67222ebef7c3927cffd7cdc8",
    "autoRetry": false,
    "autoRetryTriggered": false,
    "browser": "chrome-114",
    "comments": [],
    "commentCount": 0,
    "console": [
      {
        "url": "https://www.mgu.ac.in/wp-content/themes/MG-University-2021/assets/fontawesome/webfonts/fa-solid-900.woff2",
        "output": "Failed to load resource: the server responded with a status of 404 ()",
        "error": true,
        "dateExecuted": "2024-10-30T13:04:24.594Z",
        "_id": "67222efdf0ad7fac910e063a"
      },
      {
        "url": "https://www.mgu.ac.in/wp-content/themes/MG-University-2021/assets/images/mg-dots.png?x79481",
        "output": "Failed to load resource: the server responded with a status of 404 ()",
        "error": true,
        "dateExecuted": "2024-10-30T13:04:24.594Z",
        "_id": "67222efdf0ad7fac910e063b"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/98890.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e063c"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/6059e.css?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e063d"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/b68ea.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e063e"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/f71ea.css?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e063f"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/0130b.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e0640"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/c899d.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e0641"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/e6deb.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e0642"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/8042b.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e0643"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/77c90.css?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e0644"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/74050.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e0645"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/6cb65.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:32.011Z",
        "_id": "67222efdf0ad7fac910e0646"
      },
      {
        "url": "https://www.mgu.ac.in/inc/cache/minify/98890.js?x79481",
        "output": "4:980 \"JQMIGRATE: Migrate is installed, version 3.4.1\"",
        "error": false,
        "dateExecuted": "2024-10-30T13:04:38.255Z",
        "_id": "67222efdf0ad7fac910e0647"
      }
    ],
    "dateCreated": "2024-10-30T13:03:58.600Z",
    "deleted": false,
    "disableVisuals": false,
    "disallowInsecureCertificates": false,
    "endUrl": "https://www.mgu.ac.in/home/",
    "executionHost": "test-runner-729107.ghostinspector.net",
    "executionTime": 48725,
    "failOnJavaScriptError": false,
    "filters": [],
    "finalDelay": 5000,
    "globalStepDelay": 250,
    "language": null,
    "maxAjaxDelay": 10000,
    "maxWaitDelay": 15000,
    "name": "Gandhi University",
    "organization": {
      "_id": "6721ed79f7c3927cffca045f",
      "name": "Zeron"
    },
    "passing": false,
    "region": "us-east-1",
    "screenshotCompareDifference": 0.25,
    "screenshotCompareEnabled": true,
    "screenshotComparePassing": false,
    "screenshotCompareThreshold": 0.1,
    "startUrl": "https://www.mgu.ac.in/",
    "steps": [
      {
        "sequence": 0,
        "url": "https://www.mgu.ac.in/",
        "command": "assertElementPresent",
        "condition": null,
        "target": "body2",
        "value": "",
        "variableName": "",
        "notes": "",
        "private": false,
        "optional": false,
        "passing": false,
        "error": "Element not found",
        "extra": {
          "source": {
            "test": "****",
            "sequence": 0
          },
          "rootSequence": 0
        },
        "dateExecuted": "2024-10-30T13:04:52.567Z",
        "_id": "67222efdf0ad7fac910e0648"
      }
    ],
    "suiteResult": null,
    "test": {
      "_id": "****",
      "name": "Gandhi University",
      "suite": "****",
      "organization": "6721ed79f7c3927cffca045f"
    },
    "urls": [
      "https://www.mgu.ac.in/"
    ],
    "uuid": "92b077a5-539b-4db5-bb77-315f8e2d0511",
    "dateExecutionStarted": "2024-10-30T13:04:12.342Z",
    "screenshotCompareBaselineResult": {
      "_id": "67222aada655f16a8c32f46e",
      "screenshot": {
        "original": {
          "path": "screenshots/67727056-68cd-4319-b717-9409d9b98880.png",
          "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/67727056-68cd-4319-b717-9409d9b98880.png",
          "size": 1755133,
          "dims": {
            "w": 1280,
            "h": 2890
          }
        },
        "small": {
          "path": "screenshots/75e9a309-ce6c-4f94-8f84-0f155d446537.png",
          "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/75e9a309-ce6c-4f94-8f84-0f155d446537.png",
          "size": 190423,
          "dims": {
            "w": 320,
            "h": 723
          }
        }
      }
    },
    "dateExecutionFinished": "2024-10-30T13:05:01.067Z",
    "screenshot": {
      "original": {
        "path": "screenshots/e90dbf9f-eef8-48a2-bb89-e27af702c8e1.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/e90dbf9f-eef8-48a2-bb89-e27af702c8e1.png",
        "size": 1611059,
        "dims": {
          "w": 1280,
          "h": 2865
        }
      },
      "small": {
        "path": "screenshots/7c666162-c482-4501-b32b-1ee3d75aed4b.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/7c666162-c482-4501-b32b-1ee3d75aed4b.png",
        "size": 186595,
        "dims": {
          "w": 320,
          "h": 716
        }
      }
    },
    "screenshotCompare": {
      "compareOriginal": {
        "path": "screenshots/9026b86f-535f-485e-a150-0c27c1c93574.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/9026b86f-535f-485e-a150-0c27c1c93574.png",
        "size": 1370620,
        "dims": {
          "w": 1280,
          "h": 2865
        }
      },
      "compareSmall": {
        "path": "screenshots/5d87e1e5-794d-47c5-8fef-669b4921707d.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/5d87e1e5-794d-47c5-8fef-669b4921707d.png",
        "size": 210230,
        "dims": {
          "w": 320,
          "h": 716
        }
      }
    },
    "suite": {
      "_id": "****",
      "name": "MGU"
    }
  }
}

Alert Resolved (passing: "true")

json

{
  "type": "result",
  "data": {
    "user": {
      "_id": "****",
      "name": "Robert D"
    },
    "video": {
      "path": "videos/107490c4-649e-48f3-8744-e19bbff3818d.mp4",
      "url": "https://ghostinspector-prod.s3.amazonaws.com/videos/107490c4-649e-48f3-8744-e19bbff3818d.mp4"
    },
    "viewportSize": {
      "width": 1280,
      "height": 800
    },
    "_id": "67222f41a655f16a8c3454d5",
    "autoRetry": false,
    "autoRetryTriggered": false,
    "browser": "chrome-114",
    "comments": [],
    "commentCount": 0,
    "console": [
      {
        "url": "https://www.mgu.ac.in/wp-content/themes/MG-University-2021/assets/images/mg-dots.png?x79481",
        "output": "Failed to load resource: the server responded with a status of 404 ()",
        "error": true,
        "dateExecuted": "2024-10-30T13:06:26.756Z",
        "_id": "67222f644c8ea697a4d18058"
      },
      {
        "url": "https://www.mgu.ac.in/wp-content/themes/MG-University-2021/assets/fontawesome/webfonts/fa-solid-900.woff2",
        "output": "Failed to load resource: the server responded with a status of 404 ()",
        "error": true,
        "dateExecuted": "2024-10-30T13:06:26.756Z",
        "_id": "67222f644c8ea697a4d18059"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/98890.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d1805a"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/6059e.css?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d1805b"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/b68ea.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d1805c"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/f71ea.css?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d1805d"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/0130b.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d1805e"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/c899d.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d1805f"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/e6deb.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d18060"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/8042b.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d18061"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/77c90.css?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d18062"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/74050.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d18063"
      },
      {
        "url": "https://www.mgu.ac.in/",
        "output": "The resource https://www.mgu.ac.in/wp-content/cache/minify/6cb65.js?x79481 was preloaded using link preload but not used within a few seconds from the window's load event. Please make sure it has an appropriate `as` value and it is preloaded intentionally.",
        "error": false,
        "dateExecuted": "2024-10-30T13:06:30.437Z",
        "_id": "67222f644c8ea697a4d18064"
      }
    ],
    "dateCreated": "2024-10-30T13:06:09.989Z",
    "deleted": false,
    "disableVisuals": false,
    "disallowInsecureCertificates": false,
    "endUrl": "https://www.mgu.ac.in/",
    "executionHost": "test-runner-6d2106.ghostinspector.net",
    "executionTime": 32001,
    "failOnJavaScriptError": false,
    "filters": [],
    "finalDelay": 5000,
    "globalStepDelay": 250,
    "language": null,
    "maxAjaxDelay": 10000,
    "maxWaitDelay": 15000,
    "name": "Gandhi University",
    "organization": {
      "_id": "6721ed79f7c3927cffca045f",
      "name": "Zeron"
    },
    "passing": true,
    "region": "us-east-1",
    "screenshotCompareDifference": 0.25,
    "screenshotCompareEnabled": true,
    "screenshotComparePassing": false,
    "screenshotCompareThreshold": 0.1,
    "startUrl": "https://www.mgu.ac.in/",
    "steps": [
      {
        "sequence": 0,
        "url": "https://www.mgu.ac.in/",
        "command": "assertElementPresent",
        "condition": null,
        "target": "body",
        "value": "",
        "variableName": "",
        "notes": "",
        "private": false,
        "optional": false,
        "passing": true,
        "extra": {
          "source": {
            "test": "****",
            "sequence": 0
          },
          "rootSequence": 0
        },
        "dateExecuted": "2024-10-30T13:06:35.578Z",
        "_id": "67222f644c8ea697a4d18065"
      }
    ],
    "suiteResult": null,
    "test": {
      "_id": "****",
      "name": "Gandhi University",
      "suite": "****",
      "organization": "6721ed79f7c3927cffca045f"
    },
    "urls": [
      "https://www.mgu.ac.in/"
    ],
    "uuid": "4374e109-aa2f-42e7-9374-d2d607e86366",
    "dateExecutionStarted": "2024-10-30T13:06:12.345Z",
    "screenshotCompareBaselineResult": {
      "_id": "67222aada655f16a8c32f46e",
      "screenshot": {
        "original": {
          "path": "screenshots/67727056-68cd-4319-b717-9409d9b98880.png",
          "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/67727056-68cd-4319-b717-9409d9b98880.png",
          "size": 1755133,
          "dims": {
            "w": 1280,
            "h": 2890
          }
        },
        "small": {
          "path": "screenshots/75e9a309-ce6c-4f94-8f84-0f155d446537.png",
          "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/75e9a309-ce6c-4f94-8f84-0f155d446537.png",
          "size": 190423,
          "dims": {
            "w": 320,
            "h": 723
          }
        }
      }
    },
    "dateExecutionFinished": "2024-10-30T13:06:44.346Z",
    "screenshot": {
      "original": {
        "path": "screenshots/3e03049c-7fe0-4483-b97c-36be182b5d50.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/3e03049c-7fe0-4483-b97c-36be182b5d50.png",
        "size": 1602977,
        "dims": {
          "w": 1280,
          "h": 2865
        }
      },
      "small": {
        "path": "screenshots/8800a1ce-218a-4b4d-b962-77b7a36cfa3d.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/8800a1ce-218a-4b4d-b962-77b7a36cfa3d.png",
        "size": 184515,
        "dims": {
          "w": 320,
          "h": 716
        }
      }
    },
    "screenshotCompare": {
      "compareOriginal": {
        "path": "screenshots/c3a7784e-c17e-4714-a716-329345782c7a.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/c3a7784e-c17e-4714-a716-329345782c7a.png",
        "size": 1374669,
        "dims": {
          "w": 1280,
          "h": 2865
        }
      },
      "compareSmall": {
        "path": "screenshots/06805631-38dc-485f-b35f-ad88a84fe611.png",
        "defaultUrl": "https://ghostinspector-prod.s3.amazonaws.com/screenshots/06805631-38dc-485f-b35f-ad88a84fe611.png",
        "size": 211480,
        "dims": {
          "w": 320,
          "h": 716
        }
      }
    },
    "suite": {
      "_id": "****",
      "name": "MGU"
    }
  }
}
4.2 Configuring API Filters
4.2.1 Integration Templates

If you see an Ghost Inspector integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger and Resolve filters along with other values. The values added by the template can be modified to customize the integration according to your requirements.

4.2.2 Manually Add/Edit the Filter
  • Trigger Filter (For Creating Incidents):
  • Payload JSON Key: "data"."steps".[0]."passing"
  • Key Value Contains: [false]
  • Map Incident With: "data"."test"."_id"
  • This corresponds to the unique data.test._id from the Ghost Inspector payload.
  • Incident Title From: "data"."test"."name"
  • Incident Description From: Leave this empty unless you want to use a specific key-value from the JSON payload. If a key is entered, only the value for that key will be used as the Incident Description instead of the full JSON. By default, the Incident Description will include the full JSON values.
  • Example: If you use the "alert"."description" key in the Incident Description From field, the incident description will be the value of the "alert"."description" key. In the example JSON payload provided earlier, this would result in a description like "Element not found".
  • Resolve Filter (For Resolving Incidents):
  • Payload JSON Key: "data"."steps".[0]."passing"
  • Key Value Contains: [true]
  • Incident Mapped With: "data"."test"."_id"
  • This ensures the incident tied to the specific "data"."test"."_id" is resolved when the alert status returns to normal.

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup
  • Save the API Filters:
  • Ensure that the filters are correctly configured and saved in Callgoose SQIBS.
  • Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by Ghost Inspector.

5. Testing and Validation

5.1 Triggering Alerts
  • Simulate a Monitoring Alert:
  • Trigger a condition in Ghost Inspector that causes an alert (e.g., an important status indicator element is not present on the monitored page).
  • Verify that an incident is created in Callgoose SQIBS with the correct information.
5.2 Resolving Alerts
  • Acknowledge and Resolve the Alert:
  • Once the issue is resolved in Ghost Inspector (e.g., when the element reappears on the monitored page), verify that the incident in Callgoose SQIBS is automatically marked as resolved.

6. Security Considerations

  • API Security: Ensure that the Callgoose SQIBS API endpoint is correctly configured and that the API token is securely stored and used.
  • Ghost Inspector Permissions: Confirm that the webhook in Ghost Inspector has appropriate permissions to send alerts and data to Callgoose SQIBS.

7. Troubleshooting

  • No Incident Created: If no incident is created, verify that the webhook URL in Ghost Inspector is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
  • Incident Not Resolved: Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by Ghost Inspector matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate Ghost Inspector with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from Ghost Inspector are automatically reflected as incidents in Callgoose SQIBS, with proper resolution tracking when the issues are resolved.

For further customization or advanced use cases, refer to the official documentation for both Ghost Inspector and Callgoose SQIBS:

This documentation will guide you through the integration process, ensuring that your incidents are managed effectively within Callgoose SQIBS based on real-time alerts from Ghost Inspector.

WE ARE

An Advanced Automation platform with effective On-Call schedule, real-time Incident Management and Incident Response capabilities

MORE
ABOUT US
monitor

CALLGOOSE
SQIBS

Advanced Automation platform with effective On-Call schedule, real-time Incident Management and Incident Response capabilities that keep your organization more resilient, reliable, and always on

Callgoose SQIBS can Integrate with any applications or tools you use. It can be monitoring, ticketing, ITSM, log management, error tracking, ChatOps, collaboration tools or any applications

Callgoose providing the Plans with Unique features and advanced features for every business needs at the most affordable price.


Unique Features

  • 30+ languages supported
  • IVR for Phone call notifications
  • Dedicated caller id
  • Advanced API & Email filter
  • Tag based maintenance mode

Signup for a freemium plan today &
Experience the results.

No credit card required

Start today