Discord Setup

Send beautiful, rich-formatted notifications to your Discord server with webhook integration.

Preview

Discord notifications include:

Status-based color coding (green for success, red for failure)
Clickable links to workflow runs
Repository and branch information
Timestamp and workflow details

Step-by-Step Setup

1. Create a Webhook

Open Discord and navigate to the channel where you want notifications
Click the gear icon (⚙️) next to the channel name
Select Integrations from the left sidebar
Click Webhooks → New Webhook

2. Configure the Webhook

Name your webhook (e.g., “GitHub Notifications” or “CI/CD Bot”)
Choose an avatar (optional - you can use your project logo)
Copy the Webhook URL - it looks like:


   https://discord.com/api/webhooks/123456789012345678/abcdefghijklmnopqrstuvwxyz...

3. Add to GitHub Secrets

Go to your repository on GitHub
Navigate to Settings → Secrets and variables → Actions
Click New repository secret
Add your webhook:


Name: DISCORD_WEBHOOK
Value: https://discord.com/api/webhooks/123456789012345678/abcdefgh...

⚠️ Security Warning

Never commit webhook URLs directly to your code or repository. Always use GitHub Secrets to keep them secure.

4. Use in Your Workflow

Add this step to your GitHub Actions workflow:

.github/workflows/ci.yml


name: CI Pipeline
 
on: [push, pull_request]
 
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Build
        run: npm run build
      
      - name: Notify Discord
        if: always()
        uses: michaelikoko/workflow-blabber@v1
        with:
          channels: 'discord'
          status: ${{ job.status }}
          discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK }}

Usage Examples

Notify Only on Failure

.github/workflows/ci.yml


- name: Alert Discord on failure
  if: failure()
  uses: michaelikoko/workflow-blabber@v1
  with:
    channels: 'discord'
    status: 'failure'
    custom_message: 'Build failed! Check the logs immediately.'
    discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK }}

Custom Title and Message

.github/workflows/deploy.yml


- name: Deployment notification
  if: always()
  uses: michaelikoko/workflow-blabber@v1
  with:
    channels: 'discord'
    status: ${{ job.status }}
    custom_title: 'Production Deployment'
    custom_message: 'Version 2.0.0 has been deployed to production!'
    discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK }}

Multiple Discord Channels

You can send to multiple Discord channels by creating multiple webhooks:

.github/workflows/ci.yml


- name: Notify dev channel
  if: always()
  uses: michaelikoko/workflow-blabber@v1
  with:
    channels: 'discord'
    status: ${{ job.status }}
    discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK_DEV }}
 
- name: Notify production channel
  if: success()
  uses: michaelikoko/workflow-blabber@v1
  with:
    channels: 'discord'
    status: ${{ job.status }}
    custom_title: 'Ready for Production'
    discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK_PROD }}

Troubleshooting

Webhook Not Working?

Check these common issues:

Invalid webhook URL - Make sure you copied the entire URL including the token
Deleted webhook - Verify the webhook still exists in Discord’s Integrations settings
Channel permissions - Ensure the webhook has permission to post in the channel
Rate limiting - Discord limits webhooks to 30 requests per minute

Testing Your Webhook

You can test your webhook using curl:

terminal


curl -H "Content-Type: application/json" \
  -d '{"content": "Test message from Workflow Blabber!"}' \
  YOUR_WEBHOOK_URL

If this works, your webhook is configured correctly.

Required Input

Input	Description	Required
`discord_webhook_url`	Discord webhook URL	Yes