Create a Modern Test Plan Hook

A hook reacts to test plan lifecycle events. AFTER hooks fire once a test plan run completes, which makes them suitable for pushing results to an external system such as qTest or TestRail.

Prerequisites

• A Modern addon exists and its scaffold is downloaded.

Declare the Hook

import { defineHook } from "@testsigma/addon-sdk";

export const pushToQTest = defineHook({
  name: "qtest.afterPlan",
  description: "Push run results to qTest after the plan finishes",
  hookType: "AFTER",
  cicdCredentials: true,
  permissions: { net: ["qtest.example.com"] },
  async execute(_input, ctx) {
    const rr = ctx.runResult;
    const junit = await rr.junitXml();
    const creds = ctx.cicdCredentials;
    return { message: `Pushed run ${rr.id} (${rr.result}) to qTest` };
  },
});

What the Context Provides

result is one of SUCCESS, FAILURE, ABORTED, or STOPPED. junitXml() fetches the run's JUnit report on demand and memoizes it.

ctx.cicdCredentials is populated only when you declare cicdCredentials: true and a CI/CD integration is connected to the plan.

Declare the Hosts You Contact

Hooks run in the same sandbox as everything else. Every host your hook contacts must appear in permissions.net, or the request is blocked.

The one exception is ctx.runResult.junitXml(). Its download URL comes from the platform rather than your code, so it needs no allowlist entry.

Accept Configuration from the Plan

Hooks may declare testData and environment Zod schemas, exactly like actions. Values the test plan configurator fills in arrive as input.testData and input.environment.

Return a Message

Return { message }, or nothing. The message appears in the test plan result panel. A thrown error marks the hook invocation failed and surfaces the error message.