Webhooks

A webhook is essentially a user-defined callback over HTTP. It is an efficient way for one system to notify another about events in real time. By setting up a webhook URL within your MobileBoost account, you enable our platform to send POST requests with test results to the specified endpoint every time a test suite completes its execution.

Step-by-step Guide

Step 1: Configuration

1. Access the Settings Page: Navigate to the Settings page of our platform: https://app.mobileboost.io/gpt-driver/settings

2. Configure Webhook URL:

   • Look for the option titled “Webhook URL to be called after test suite run”.

   • Input the webhook URL where you want to receive the POST requests. Ensure it's a valid and accessible endpoint.

3. Authorization (Optional):

   • If your server requires an authorization header for incoming requests, input the authorization value in the provided field called “(Optional) Webhook authorization header”

Step 2: Payload Structure

Once the webhook is set up, after each test suite run, our platform will send a POST request to the specified URL. The request body will carry a JSON payload with the test results. Here is a sample structure of the payload:

{
  "totalTests": 1,
  "succeededTests": [],
  "failedTests": [
    {
      "id": "teXiuNg4TLL9ioHIct5H",
      "startTimeInEpoch": 1696263692,
      "finishTimeInEpoch": 1696263713,
      "title": "3sec failing",
      "status": "failed",
      "statusMessage": "error detected: The installation of the app has failed, preventing the execution of the test steps. The app needs to be correctly installed before we can proceed.",
      "recording": "https://app.mobileboost.io/recording/jhn7urWc/runs/teXK9ioHIct5H",
      "platform": "android",
      "device": "pixel7",
      "orientation": "portrait",
      "os": "13.0",
      "coordinates": {},
      "locale": "fr_FR",
      "tags": [
        "test tag"
      ]
    }
  ],
  "blockedTests": [],
  "appInfo": "Test App",
  "startTimeInEpoch": 1696263663,
  "appVersionCode": "1123",
  "appVersionName": "2.4.9",
  "platform": "android",
  "bundle": "com.test.app",
  "uploadId": "JbUOAOHLx99O2MYJc0LC",
  "trigger": "API",
  "metaData": {},
  "testSuiteId": "99a7a26d1c914f77916f35ca76291d82"
}