Slack Target Reference

Send test results to Slack channels using incoming webhooks.

Prerequisites

Create a Slack incoming webhook URL by following the official Slack documentation.

Configuration

Basic Configuration

{
  "name": "slack",
  "inputs": {
    "url": "<slack-incoming-webhook-url>"
  }
}

Complete Configuration

{
  "name": "slack",
  "condition": "fail",
  "inputs": {
    "url": "<slack-incoming-webhook-url>",
    "publish": "test-summary",
    "only_failures": false,
    "title": "Custom Test Results",
    "title_link": "https://ci.example.com/build/123",
    "title_suffix": " - Production",
    "max_suites": 15,
    "message_format": "attachments"
  }
}

Properties

Property	Type	Description	Default
url	string	Slack incoming webhook URL	Required
publish	string	Report type to publish	"test-summary"
only_failures	boolean	Show only failed tests	false
title	string	Custom report title	Auto-generated
title_link	string	Clickable link on title	None
title_suffix	string	Text appended to title	None
max_suites	number	Maximum suites to display	10
message_format	string	Slack message format	"attachments"

Report Types

test-summary

Complete test results with suite breakdown and metrics.

Single Test Suite:

Multiple Test Suites:

test-summary-slim

Condensed results without suite details. Perfect for keeping primary channels clean.

failure-details

Detailed information about failed tests including error messages and stack traces.

Message Formats

Format	Description
"attachments"	Legacy Slack attachments (default)
"blocks"	Modern Slack Block Kit format

Command Line Usage

Basic Usage

npx testbeats@latest publish \
  --slack '<webhook-url>' \
  --junit '<report-path>'

With Options

npx testbeats@latest publish \
  --slack '<webhook-url>' \
  --junit '<report-path>' \
  --api-key '<api-key>'

Configuration File Examples

Development Team Channel

{
  "targets": [
    {
      "name": "slack",
      "condition": "fail",
      "inputs": {
        "url": "<dev-channel-webhook>",
        "publish": "failure-details",
        "title": "🚨 Test Failures",
        "only_failures": true
      }
    }
  ]
}

Management Dashboard

{
  "targets": [
    {
      "name": "slack",
      "inputs": {
        "url": "<management-channel-webhook>",
        "publish": "test-summary-slim",
        "title": "📊 Daily Test Report",
        "message_format": "blocks"
      }
    }
  ]
}

Multiple Environments

{
  "targets": [
    {
      "name": "slack",
      "inputs": {
        "url": "<staging-webhook>",
        "title_suffix": " - Staging"
      }
    },
    {
      "name": "slack",
      "inputs": {
        "url": "<production-webhook>",
        "title_suffix": " - Production",
        "publish": "test-summary-slim"
      }
    }
  ]
}

Extensions Support

Slack targets support all TestBeats extensions:

• Mentions - Tag team members
• Hyperlinks - Add clickable links
• Metadata - Include build information
• CI Info - Show CI/CD context
• Chart Test Summary - Visual charts
• Report Portal Analysis - ReportPortal integration

Troubleshooting

Common Issues

Webhook URL not working:

• Verify the webhook URL is correct and active
• Test the webhook URL manually using curl
• Check Slack app permissions

Messages not appearing:

• Ensure the bot has permission to post in the channel
• Verify the webhook is associated with the correct workspace
• Check Slack's rate limiting

Formatting issues:

• Try switching between "attachments" and "blocks" message formats
• Verify special characters are properly escaped
• Check message size limits

Testing Configuration

# Test with minimal configuration
npx testbeats@latest publish \
  --slack '<webhook-url>' \
  --junit '<sample-report>' \
  --verbose

Related

• Teams Target - Microsoft Teams integration
• Chat Target - Google Chat integration
• Extensions - Enhance Slack messages
• Conditions - Control when to send messages