๐Ÿค–
DoesQA Docs
  • โœจWelcome to DoesQA
  • Additional Items
    • ๐Ÿ› ๏ธGetting Started
    • ๐Ÿ”—Nodes
      • Starters
      • Actions
      • Checks
        • Comparison Types
      • Change Detection
      • Validators
      • Data
      • Integrations
      • Utilities
      • Runner
    • ๐ŸงชTests
    • ๐ŸชจElements
    • ๐Ÿ”ขValues (Value Store)
    • ๐ŸชCI/CD - Webhook Configuration
    • โ–ถ๏ธRun Events
    • ๐ŸŒŸNode Groups
    • Whitelisting IPs
Powered by GitBook
On this page
  • Creating a new event
  • Schema
  • Verifying request came from DoesQA
  1. Additional Items

Run Events

Trigger remote tooling straight out of DoesQA

Within Settings (โš™๏ธ) -> Events you are able to configure new and update existing events.

Events fire once a run is complete and can be hooked into passed, failed, and rejected statuses

Creating a new event

Name

Used to identify the run event

Run Statuses

You can pick when this event fires, on Passed, Failed, or Rejected test runs.

Webhook URL

The location that we will POST to

Webhook Headers

A JSON field for key-value headers to be set when we send the request. See Verifying request came from DoesQA for information on default headers set by us.

Schema

Below is the expected schema you will receive

{
  "status": "passed" | "failed" | "rejected",
  "run": {
    "runId": string,
    "triggerName": string,
    "triggerLabel": string
  },
  "testCases": 
    {
      "attributes": {
        "title": string,
        "status": string,
        "completedAt": string (ISO),
        "startedAt": string (ISO),
        "flow": {
          "title": string,
          "video": boolean,
          "lighthouse": boolean
        },
        "steps": {
            "status": string,
            "startedAt": string (ISO),
            "endedAt": string (ISO),
            "url": string,
            "node": {
              "variantType": string,
              "comparisonType": string,
              "value": string,
              "elementType": string,
              "elementSelector": string,
              "elementTitle": string,
              "label": string
            }
          }[]
      }
    }[]
}

Verifying request came from DoesQA

We add a x-doesqa-signature header to our POST, which will display the value shown when you set the event up. Use this header to validate that the request came from us.

PreviousCI/CD - Webhook ConfigurationNextNode Groups

Last updated 1 year ago

โ–ถ๏ธ