How to Setup Slack

Send a message to a Slack channel when an upload starts, finishes, or fails - and optionally edit that same message later.

I want to...	I need
Post a message to a Slack channel	A bot with a token (§1, §2) + a Server and Channel (§3)
Edit that message afterwards	The above, plus a Message Name Format on the send action (§4)

---

Where things get saved

• Edit->Preferences->Build Uploader->Services->Slack holds your bot token. Saved to your own PC only and never written into your project. Every person on your team enters their own.
• Project Settings->Build Uploader->Services->Slack holds server names, channel IDs and app names. Saved to <YourProjectPath>/BuildUploader/ and safe to commit so your team shares them.

Create the entry in Project Settings, then enter its secret in Preferences. The Name is what links the two - it must match exactly.

---

1. Create a Slack bot

• Go to the Slack developer dashboard
  • (Or press the Developer Dashboard button at the top of the Preferences page)
• Press Create New App->From scratch
  • Give it a name (eg: Build Uploader) and pick your workspace
• Give the bot permission to post
  • Go to OAuth & Permissions in the left sidebar
  • Scroll to Scopes->Bot Token Scopes and press Add an OAuth Scope
  • Add chat:write
  • Add chat:write.public as well if you want it to post in channels it hasn't been invited to
• Install it
  • Scroll back to the top of OAuth & Permissions and press Install to Workspace
  • Approve the permissions
  • Copy the Bot User OAuth Token (starts with xoxb-)

!NOTE: If you skipped chat:write.public, you must invite the bot to each channel you want it to post in. In Slack, type /invite @YourBotName in that channel.

---

2. Setup Preferences: Edit->Preferences->Build Uploader->Services->Slack

• Turn on Enabled
• Under Apps press + to create a new App
  • Name: anything you like. This is just a label so you can pick it in a dropdown later. eg: Build Bot
  • Token: paste the Bot User OAuth Token from step 1
    • Tick Show if you want to see what you pasted

---

3. Setup Project Settings: Project Settings->Build Uploader->Services->Slack

Add the App

• Under Apps press +
• Enter the exact same Name you used in Preferences

Add your workspace and channels

• Press Add Server at the top
  • Name: your workspace name. Anything you like. eg: My Studio
  • Server ID: a number used to keep channels grouped in the UI. It is not sent to Slack, so 0 is fine
• Under Channels press + for each channel you want to post to
  • Name: anything you like. eg: Build Notifications
  • Channel ID: the real Slack channel ID. This one matters

Finding a Channel ID

• Open the channel in Slack
• Press the channel name at the top -> scroll to the bottom of the About tab
• Copy the Channel ID (starts with C. eg: C01ABC2DE3F)
  • You can also read it from the URL when using Slack in a browser - it's the last part of the address

---

4. Use it in an Upload Config

• Go to Window->Build Uploader->Open Window
• Add a Slack Send Message action to your Upload Config
  • App: the App you made
  • Server: the workspace you made
  • Channel: the channel you added
  • Text: the message. Supports {keys} - see String Formatter
  • Attachments: optional. Use these to format the message more nicely
  • Message Name Format: optional. Only needed if you want to edit this message later - see below
• Set Triggers and When To Execute to control when it fires
  • eg: OnTaskFinished + Always posts once at the end whether the upload passed or failed
  • eg: OnTaskStarted + Always posts as soon as the upload begins

Editing a message later

A common setup is "post Uploading... when the task starts, then edit it to Done! when it finishes". This needs two actions:

• On the Slack Send Message action, set Message Name Format to a name of your choosing. eg: SlackBuildMessage
  • Do not include the curly braces - the Build Uploader adds them
  • This saves the timestamp of the message it just sent
• Add a second action, Slack Update Message
  • Fill in the same App, Server and Channel
  • Text: the new text to replace the message with
  • Message Timestamp: {SlackBuildMessage} - the name you chose above, in curly braces
• Set the first action to trigger OnTaskStarted and the second to trigger OnTaskFinished