Skip to main content

Slack Release Notifications

Send automatic notifications to a Slack channel — including the download link and QR code — every time you run frx build.

Slack Setup

Need to create a Slack Bot and get a token? See the Slack Setup Guide.

Prerequisites​

  • A Slack workspace with a channel for build notifications
  • A Slack Bot with chat:write and files:write scopes
  • Your Bot's OAuth Token (xoxb-...) and the target Channel ID

Step 1: Configure config.yaml​

upload_options:
  slack:
    enabled: true
    bot_user_oauth_token: YOUR_BOT_TOKEN   # xoxb-XXXXXXXXX-XXXXXXXXX-XXXXXXXXXXXXX
    default_channel_id: CHANNEL_ID         # e.g., C0XXXXXXXXX
    share_QR: true             # Share QR code image in the message
    share_link: true           # Share the build download link
    custom_message: "🚀 New build is ready! Download and test now."
    mention_users:             # Optional: Slack Member IDs to @mention (not usernames)
      - "U0XXXXXXX"
      - "U08XXXXXXXX"
important

share_link requires at least one cloud upload (e.g., github or google_drive) to be enabled. Without an upload, FRX will share a local path instead.

Step 2: Build and Notify​

frx build

After a successful build and upload, FRX will post a Slack message with:

  • ✅ Your custom message
  • 📎 QR code image (if share_QR: true)
  • 🔗 Download link (if share_link: true)
  • 👋 @mentions for listed user IDs

Send a Standalone Notification​

You can also send notifications without triggering a build:

frx notify --platform slack --message "🚀 v1.0.0 is live!"
# Shorthand:
frx notify -p slack -m "🚀 v1.0.0 is live!"

Troubleshooting​

IssueFix
Bot doesn't post to channelEnsure the bot is invited to the channel
Users not mentionedUse Member IDs (e.g., U0XXXXXXX), not display names
Link not sharedEnable at least one upload option (github, google_drive, etc.)
Security

Never commit your bot_user_oauth_token to a public repo. Add config.yaml to your .gitignore.

What's Next?​