Docs

Kaloko

Download
Markdown with pictures (.zip)Docusaurus folder (.zip)VitePress folder (.zip)MkDocs folder (.zip)Offline HTML (.zip)PDFChangelog as JSON
Pages

Connect Jira, Linear, Slack and Teams

For organization admins on the Team plan and up. Once connected, people file a returned step as an issue straight from the canvas, and each project tells its own chat channel what happened.

Jira or Linear

  1. Open Settings → Integrations and connect Jira Cloud (sign in with Atlassian, or paste an API token) or Linear (sign in, or paste an API key).
  2. Map each Kaloko project to a Jira project and issue type, or to a Linear team. A default row covers projects you do not list.
  3. For Jira, add the webhook Kaloko shows to your Jira site, so a finished issue closes its comment in Kaloko at once. Without it, Kaloko checks every 30 minutes.

People then choose New issue on a step. The issue gets the screenshot, the criterion and the reviewers' notes, with a link back.

A scenario that walks a site for health (SEO, accessibility) can also open one issue per new finding by itself, close it when the finding is fixed and comment when many more or fewer pages are hit. A Developer / Tester switches it on per scenario: Health API for dashboards, section Findings.

GitHub Issues or Plane for findings

Findings can go to GitHub Issues and Plane too; issues from steps stay with Jira and Linear.

  • GitHub: the Kaloko GitHub app opens issues on the repositories it is installed on once you accept its Issues permission on GitHub. For other repositories, paste a fine-grained token under GitHub Issues for findings (only the repositories you sync to, Issues: read and write).
  • Plane: paste the workspace slug and an API key under Plane (Profile settings → Personal access tokens). Leave the address empty for Plane Cloud; a self-hosted Plane must be on a public https address.

Kaloko checks the token or the key before it stores it and never shows it again. Then list, per Kaloko project, the repositories and Plane projects its scenarios may send findings to (a default row covers the rest); a Developer / Tester can pick only from that list. Which scenario sends which findings where is set per scenario, with the repository, the Plane project and routes per check or pack.

Slack or Teams channels

  1. In Settings → Integrations, add a channel for a project: Add to Slack for Slack, or the address of a Teams Workflows flow for Microsoft Teams.
  2. Tick the events the channel wants: new run, returned, accepted, comment, mention, release recorded, waiting for approval, health got worse.
  3. Set quiet hours if the channel should not hear from Kaloko at night; messages wait until they end.

A restricted project only reaches channels that name it. The organization-wide Slack channel keeps working.

Ask approvers in Slack and Teams

When a run waits for the required approvers of its scenario, each of them gets the e-mail and the inbox item. With Slack connected, Kaloko also writes to every approver whose e-mail address belongs to someone in your Slack workspace. The message links straight into review mode of the run.

  • Teams workflows cannot write to one person, so in Teams the approvers are named in the channels that take Waiting for approval. Slack channels with that event name them too.
  • If nobody has decided after 24 hours, each approver gets one reminder. Change the hours or turn the reminder off in Settings → Integrations → Ask approvers in Slack and Teams.
  • Quiet hours there hold the direct messages until the morning of each approver's own time zone.
  • If Slack was connected before Kaloko could write to people, that settings block says so. Connect Slack again once.
  • Guests who turned approval requests off for a project are not written to.
On this pageOn this page