Link Search Menu Expand

Discord Integration

Multi-channel notifications for builds, assets, alerts, and approvals.

Table of contents

  1. Overview
  2. Configuration
    1. Connection Settings
  3. Setup Steps
    1. 1. Create Discord Webhooks
    2. 2. Add the Integration
    3. 3. Configure Multi-Channel (Optional)
  4. Notification Types
    1. Build Notifications
    2. Asset Notifications
    3. Alert Notifications
    4. Approval Requests
  5. Rich Embeds
    1. Color Codes
  6. Notification Preferences
  7. Webhook Payload Format
    1. Build Started
    2. Build Failed
  8. Rate Limiting
  9. Troubleshooting
    1. Notifications Not Appearing
    2. Invalid Webhook Token
    3. Rate Limited
    4. Wrong Channel
  10. Best Practices

Overview

ButterStack integrates with Discord via webhooks to provide:

  • Build status notifications
  • Asset approval requests
  • Alert and error notifications
  • Multi-channel routing
  • Rich embeds with asset previews

Configuration

Connection Settings

FieldDescriptionRequiredExample
webhook_urlDefault webhook URLYeshttps://discord.com/api/webhooks/...
builds_channel_webhook_urlWebhook for build notificationsNoSeparate URL
assets_channel_webhook_urlWebhook for asset notificationsNoSeparate URL
alerts_channel_webhook_urlWebhook for alerts and errorsNoSeparate URL
approvals_channel_webhook_urlWebhook for approval requestsNoSeparate URL

Setup Steps

1. Create Discord Webhooks

For each channel you want to receive notifications:

  1. Open Discord server settings
  2. Go to Integrations > Webhooks
  3. Click New Webhook
  4. Name it (e.g., “ButterStack Builds”)
  5. Select the target channel
  6. Copy the webhook URL

2. Add the Integration

  1. Go to Project Settings > Integrations
  2. Click Add Integration
  3. Select Discord
  4. Paste your webhook URL(s)
  5. Test the connection
  6. Save

3. Configure Multi-Channel (Optional)

Route different notification types to different channels:

Notification TypeRecommended Channel
Build notifications#builds
Asset notifications#assets
Alerts and errors#alerts
Approval requests#approvals

If a specific webhook URL isn’t set, notifications use the default webhook.

Notification Types

Build Notifications

Sent when builds start, complete, or fail:

{
  "embeds": [{
    "title": "Build Completed",
    "description": "Windows build for MyGame completed successfully",
    "color": 5763719,
    "fields": [
      {"name": "Build Number", "value": "456", "inline": true},
      {"name": "Duration", "value": "15m 23s", "inline": true},
      {"name": "Platform", "value": "Win64", "inline": true}
    ],
    "footer": {"text": "ButterStack Build System"}
  }]
}

Asset Notifications

Sent when assets are uploaded or modified:

  • New asset uploads
  • Asset modifications
  • Asset deletion

Alert Notifications

Sent for errors and warnings:

  • Build failures
  • Integration connection issues
  • System errors

Approval Requests

Sent when assets need review:

  • Asset approval requests
  • Manifest approval requests
  • Links to approve/reject in ButterStack

Rich Embeds

Discord notifications use rich embeds with:

  • Color-coded status (green = success, red = failure, yellow = pending)
  • Inline fields for key information
  • Timestamps
  • Footer with build/asset IDs

Color Codes

StatusColorHex
SuccessGreen#10B981
FailureRed#EF4444
WarningYellow#F59E0B
InfoBlue#3B82F6
PendingGray#6B7280

Notification Preferences

Configure which notifications to receive in project settings:

  1. Go to Project Settings > Notifications
  2. Find Discord section
  3. Toggle notification types:
    • Build started
    • Build completed
    • Build failed
    • Asset uploaded
    • Approval requested
    • System alerts

Webhook Payload Format

Build Started

{
  "content": null,
  "embeds": [{
    "title": "Build Started",
    "description": "Building MyGame for Win64",
    "color": 3447003,
    "fields": [
      {"name": "Job", "value": "MyGame-Build", "inline": true},
      {"name": "Triggered By", "value": "john.doe", "inline": true}
    ],
    "timestamp": "2026-12-15T10:30:00Z"
  }]
}

Build Failed

{
  "content": "@here Build failed!",
  "embeds": [{
    "title": "Build Failed",
    "description": "MyGame Win64 build failed",
    "color": 15548997,
    "fields": [
      {"name": "Build Number", "value": "456", "inline": true},
      {"name": "Error", "value": "Compilation error in GameMode.cpp", "inline": false}
    ],
    "timestamp": "2026-12-15T10:45:00Z"
  }]
}

Rate Limiting

Discord webhooks have rate limits:

  • 30 requests per minute per webhook
  • ButterStack queues messages to avoid hitting limits
  • High-volume projects may need multiple webhooks

Troubleshooting

Notifications Not Appearing

  • Verify webhook URL is correct (test in Discord settings)
  • Check channel permissions allow webhook messages
  • Verify ButterStack can reach Discord (firewall/proxy)
  • Check ButterStack notification logs

Invalid Webhook Token

  • Webhook may have been deleted - create a new one
  • Update the URL in ButterStack settings

Rate Limited

  • Reduce notification frequency in settings
  • Use separate webhooks for different notification types
  • Consider batching similar notifications

Wrong Channel

  • Verify you copied the correct webhook URL
  • Each webhook is tied to a specific channel
  • Create separate webhooks for each target channel

Best Practices

  1. Use multiple channels - Route different notification types to appropriate channels
  2. Set up alerts channel - Critical alerts shouldn’t be buried in general notifications
  3. Configure permissions - Only notify relevant team members
  4. Test webhooks - Verify each webhook works before going live
  5. Monitor rate limits - High-activity projects need multiple webhooks

Back to top

Copyright © 2026 ButterStack. All rights reserved.