This page is the guide for slack integration.

Slack is a messaging application designed for businesses that enables individuals to access the information they require. By uniting people to function as a cohesive team, Slack revolutionizes the way organizations communicate.

For more information about Slack, click here.

Adding a new connection

  1. Enter your app name and select your slack workspace.

  2. Then click on Create App

  3. Go back to Basic Information on the left sidebar.

  4. Scroll down to App Credentials.

    • Copy Client ID into the API Key field in Plumber

  5. Click on Submit.

  6. A new window with the Slack consent screen will pop up.

  7. Your Slack integration is now ready!

Send a message to a channel


If you do not find your channel in the dropdown list, ensure that the channel is Public or the user that your API token is created under has access to the channel.

Public channel

Select from the dropdown list of channels.

Private channel

To send to private channels, you would need the Slack ID of the private channel. To retrieve this:

  1. start by typing /display ids into any conversation on Slack.

  2. Select the built-in shortcut Display IDs

  3. Copy and paste the selected conversation/channel ID into Plumber and click Use: <CHANNEL_ID>

  4. You can now either send as yourself (i.e. Send as bot? False) or invite the app into the private channel to send as a bot.

Message text

To mention users, use the following format: <@USER_ID>. e.g.:

Hey <@U024BE7LH>, thanks for submitting your report.

To get the user's ID, click on the overflow button in their Slack profile, and choosing the Copy member ID option.

To mention user groups, use the following format: <!subteam^ID>, e.g.:

Hey <!subteam^SAZ94GDB8>, there's a new task in your queue.

You can also manually retrieve a specific user group's ID by clicking Copy group ID in the overflow menu.

Send as a bot?

If false, the message will be sent as yourself.

Last updated