Webhook Notifications

CheckView can send test flow results to a custom webhook URL, enabling integration with external monitoring tools, dashboards, or automation workflows.

Setting Up Webhook Notifications

  1. Open the Test Flow you want to configure.
  2. Click the Settings gear icon.
  3. Navigate to Notifications.
  4. In the Webhook section, enter your webhook URL.
  5. Click Save changes.

Webhook Payload

When a test completes, CheckView sends a POST request to your webhook URL with a JSON payload describing the test result. Here is an example:

{
  "url": "https://app.checkview.io/organizations/{org_id}/tests/{test_id}",
  "event": "test.completed",
  "test": {
    "id": "4632c522-ff80-4a39-99f6-987415904cd9",
    "test_flow_id": "e3fb33f4-4f7e-4ca6-a478-6195c82028c5",
    "test_flow_name": "Free Estimate",
    "status": "success",
    "website_url": "https://example.com",
    "page_url": "https://example.com/free-estimate/",
    "created_at": "2026-07-07T20:43:36.411Z",
    "completed_at": "2026-07-07T20:44:11.696Z"
  },
  "organization": { "id": "d0afe1be-...", "name": "Your Organization" },
  "website": { "id": "4852da5e-...", "url": "https://example.com" },
  "steps": [
    { "index": 0, "name": "goto", "status": "success" },
    { "index": 1, "name": "assign", "status": "success", "value": "Jane", "field": "First Name" },
    { "index": 2, "name": "assign", "status": "success", "value": "[email protected]", "field": "Email" },
    { "index": 3, "name": "select", "status": "success", "value": "Word of mouth", "field": "How did you hear about us?" },
    { "index": 4, "name": "click", "status": "success" }
  ]
}

Fields

  • url — Link to the full test results in the CheckView dashboard.
  • event — Always test.completed.
  • test — Details of the completed test: id, test_flow_id, test_flow_name, status (success or error), website_url, page_url, created_at, and completed_at.
  • organization — The organization the test belongs to (id, name).
  • website — The website that was tested (id, url).
  • steps — An array of the individual steps CheckView ran, in order. Each step includes:
    • index — The step’s position in the flow (starting at 0).
    • name — The step type (for example goto, assign, select, click).
    • status — success or error.
    • value — The value entered or selected for the step, when applicable (for example the email address typed into a form field). Present only for steps that carry a value.
    • field — The label of the field the step targets, when known (for example Email).
    • error_message — A description of what went wrong, present only when the step failed.

Note: Login credential fields (username and password) and credit card numbers are never included in the payload — for those steps the value is omitted. All other field values are sent to your endpoint exactly as they were entered, so avoid placing sensitive data (for example bank account, IBAN, or national ID numbers) in test fields unless your webhook endpoint is an appropriate place to receive it.

Routing notifications with step values

Because each step’s value is included, you can drive your own notification routing from the payload. For example, if one of your form fields is set to the email address you want notified, your automation tool (Zapier, Make, n8n, etc.) can read that value from the steps array and send a message to the right recipient.

Use Cases

  • Custom dashboards: Feed test results into your own monitoring dashboard.
  • Automation workflows: Trigger follow-up actions (e.g., create a ticket, send a text message) when a test fails.
  • Third-party integrations: Connect to tools like Zapier, Make, or n8n for custom notification routing.

Webhook notifications are available at both the organization and test flow levels.

Related Articles

Docs