nf-slack plugin

Get Slack notifications for your Nextflow workflows — automatically notified when pipelines start, complete, or fail.

📖 Full documentation: https://seqeralabs.github.io/nf-slack/

Important

This is an open-source project for community benefit. It is provided as-is and is not part of Seqera's officially supported toolset.

Features

• Automatic Notifications — Workflow start, completion, and error events
• Custom Messages and File Uploads — From within your pipeline code
• Threading, Reactions, and Progress Updates — Keep channels organized
• Seqera Platform Integration — One-click navigation to your runs

Get Started

Add to your nextflow.config:

plugins {
    id 'nf-slack@0.5.1'
}

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

Run your pipeline — you'll get Slack notifications automatically:

See the Setup Guide for bot and webhook configuration options.

Documentation

• Setup Guide — Installation, bot/webhook setup
• Usage Guide — Notifications, threading, custom messages, file uploads
• Examples — Copy-paste configuration examples
• API Reference — All configuration options
• Contributing — Development setup and guidelines

Examples

Here are a few common configurations to get you started:

Basic bot notifications:

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

Threaded messages with start, complete, and error events:

slack {
    enabled = true
    bot {
        token = 'xoxb-your-bot-token'
        channel = 'pipeline-results'
    }
    useThreads = true
    onStart.send = true
    onComplete.send = true
    onError.send = true
}

See the Examples Gallery for more copy-paste configurations.

Support

• Report bugs
• Request features

License

Copyright 2025, Seqera Labs. Licensed under the Apache License, Version 2.0.