Connect any app with Zapier

Connect, step by step

1. In qarunbook

   Make an API key

   Choose API at the foot of the sidebar, then Create key. Name it Zapier and pick the Role the Zap needs:

   • Viewer — triggers and searches only;
   • Tester — also raises issues and records results;
   • Admin — also marks issues fixed.

   Under Apps, leave All apps, or choose Only some and tick the apps the Zap may reach. Choose Create key.

   Choose Copy. The key starts qrk_live_ and is shown only this once. Then choose I've saved it.

2. In Zapier

   Start a Zap

   In Zapier, choose Create Zap. For the Trigger, pick the app the Zap starts from — a form tool, ClickUp, Asana — or QA Runbook itself. Then add an Action and pick the app it ends in.

   You can also start from QA Runbook's page on Zapier, which lists ready-made pairings.

3. In Zapier

   Sign in to QA Runbook with the key

   On the QA Runbook step, choose its Event (the list is below), then Sign in under Account. Paste the key into Workspace API key and continue.

   The account is now listed as your workspace's name with the key's name — Acme QA (Zapier). Every later QA Runbook step can reuse it.

4. In Zapier

   Choose the app, fill in the fields, publish

   Pick the qarunbook App in the step's fields; the Check and Platform lists fill in from it. Map the rest from the trigger — for Raise Issue, put the form's or task's text in What Went Wrong.

   Choose Test step, then Publish.

Check it works

1. In Zapier

   Test the Raise Issue step

   In a Zap whose action is QA Runbook's Raise Issue, choose Test step. Zapier sends a real request, and shows the new issue's Issue ID and Status.

2. In qarunbook

   See it arrive

   Open the app. The issue is there with the text Zapier sent, raised by the key's name — or by the Reporter Name, if you filled one in.

3. In Zapier

   Check a trigger

   For a Zap that starts from QA Runbook, choose Test trigger. Zapier pulls in the newest issue, fix or result from the apps the key can reach. If there is none yet, raise one first.

What QA Runbook offers in Zapier

Triggers — start a Zap when…

• New Issue — an issue is raised. Optionally in one app.
• Issue Marked Fixed — an issue is marked fixed, from anywhere: in qarunbook, from GitHub, Jira or another tool. An issue reopened and fixed again triggers again.
• New Test Result — a pass or fail is recorded for a check on a platform. Optionally in one app, and Failures Only.

Actions — do this in qarunbook

• Raise Issue — against a check, which then reads failed until it is fixed and retested. On a live app the check is optional, and Section and Priority can be set. Needs a tester or admin key.
• Mark Issue Fixed — sends its check back for a retest. Needs an admin key.
• Record Test Result — a pass, fail or retest for an existing check on one platform. Needs a tester or admin key.

Searches — find something for a later step

• Find Check — by its ref, such as AUTH-01, with its status on each platform.
• Find Issue — by its ID, or the newest open issue on a check.
• Find or Raise Issue — finds the newest open issue on a check, or raises one if there is none. A failure that repeats every night raises one issue, not one a night.

Examples

• A form or a support inbox → Raise Issue. A bug report form's answers become an issue on a live app, with the person who filled it in as Reporter Name and Reporter Email.
• A ClickUp, Asana or Trello task → Raise Issue. A task added to a Bugs list or column becomes an issue in qarunbook, where it is tracked until retested.
• Issue Marked Fixed → a message in a channel. Tell testers in the chat tool you use that something is ready to retest, with the issue text and who fixed it.
• New Test Result (Failures Only) → a message or a task. Every failure reaches the people who need to know, as it is recorded.

How it works

Zapier works through the workspace's API key, not a per-app connection: there is nothing to switch on in an app's Integrations tab, and the Zapier tile there only says how. Each Zap names the app it works on in its fields, and can reach any app the key can.

Every step is a call to the qarunbook REST API with that key, so it does exactly what the API does, with the key's role. Triggers are polled: Zapier asks for anything new on its own schedule, every few minutes depending on your Zapier plan.

Good to know

• Zaps bring bugs in, send the news out and bring fixes back. They do not create checks or sections: those stay in your test plan in qarunbook. Record Test Result and Raise Issue work on checks that already exist.
• Use one key per tool, at the lowest role that does the job. A Zap that only watches for fixes needs only a viewer key.
• A key refused for its role is named in Zapier's error: recording results and raising issues need a tester key; marking issues fixed needs an admin key.
• A key limited to Only some apps sees only those apps, in triggers and in the App list.
• Calls count towards the key's rate limit. When Zapier goes over it, Zapier waits and tries again.
• Already have a tile for your tool? Use it: Slack, Jira, GitHub and the rest talk to qarunbook directly, and send the fix back to the thread or ticket the bug came from.