nf-slack¶

Slack notifications for your Nextflow workflows. Get notified when pipelines start, complete, or fail — with no changes to your pipeline code.

Default notifications

Features¶

Automatic notifications — workflow start, completion, and error events
Custom messages and file uploads from within your pipeline code
Threading, reactions, and progress updates to keep channels organized
Seqera Platform integration — one-click navigation to your runs

Quick Start¶

1. Add the plugin to your nextflow.config:

plugins {
    id 'nf-slack@0.5.1'
}

slack {
    enabled = true
    bot {
        token = 'xoxb-your-bot-token'
        channel = 'pipeline-notifications'
    }
}

2. Run your pipeline — that's it! You'll get Slack notifications automatically.

Need help setting up Slack?

See the Setup Guide for step-by-step instructions on creating a Slack app and choosing between Bot and Webhook modes.

What Can You Do?¶

Feature	Example	Guide
Control which events notify	`onStart.enabled = false`	Usage Guide
Customize message text	`onComplete.message = 'Done!'`	Usage Guide
Thread notifications	`useThreads = true`	Usage Guide
Upload files on completion	`onComplete.files = ['report.html']`	Usage Guide
Send messages from code	`slackMessage('Hello!')`	Usage Guide
Upload files from code	`slackFileUpload('results.csv')`	Usage Guide

Documentation¶

Setup Guide — Install the plugin and configure Slack
Usage Guide — All features and configuration options
Examples — Runnable examples with screenshots
API Reference — Complete property and function reference