README.md

Slack Plugin

• Learn more about Allure Report at https://allurereport.org
• 📚 Documentation – discover official documentation for Allure Report
• ❓ Questions and Support – get help from the team and community
• 📢 Official announcements – be in touch with the latest updates
• 💬 General Discussion – engage in casual conversations, share insights and ideas with the community

---

Overview

The plugin sends notifications about failed tests to a given Slack channel.

Install

Use your favorite package manager to install the package:

npm add @allurereport/plugin-slack
yarn add @allurereport/plugin-slack
pnpm add @allurereport/plugin-slack

Then, add the plugin to the Allure configuration file:

import { defineConfig } from "allure";

export default defineConfig({
  name: "Allure Report",
  output: "./allure-report",
  historyPath: "./history.jsonl",
  plugins: {
+    slack: {
+      options: {
+        channel: "my_channel",
+        token: "my_token",
+      },
+    },
  },
});

Options

The plugin accepts the following options:

Option	Description	Type
channel	Name of the target channel	string
token	Slack API token	string