---
description: This page is the guide for slack integration.
---

# Slack

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](https://slack.com/help/articles/115004071768-What-is-Slack-).

### Adding a new connection

1. Head to this [link](https://api.slack.com/apps) and click on **Create New App > From scratch**\
   ![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FhGSn1KhoZyOLrRItRDsN%2Fimage.png?alt=media\&token=be19edc1-592a-4bf4-9f37-90152d6300a1)
2. Enter your app name and select your slack workspace.
3. Then click on **Create App**
4. Go to **OAuth & Permissions** page.\
   &#x20;![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FucI6rG3SVwUKbrpQu9zt%2Fimage.png?alt=media\&token=b9bee566-6605-4bf0-be37-bb609474576c)
5. Copy **OAuth Redirect URL** from Plumber and add it in Redirect URL. Click on **Save URLs.**\
   ![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FdDwJTvgFbtviVOaZBPLt%2Fimage.png?alt=media\&token=3029b5be-db99-457f-bb0b-1e7726fcfb42)
6. Go to **Bot Token Scopes** and add `chat:write.customize` along with `chat:write` scope to enable the bot functionality.\
   ![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FZD3Y7vQIRFbFgtncyd8W%2Fimage.png?alt=media\&token=8a4923b0-4270-42eb-bf0e-8e937ff58dff)
7. Go back to **Basic Information** on the left sidebar.
8. Scroll down to **App Credentials**.&#x20;
   * Copy **Client ID** into the **API Key** field in Plumber
   * Copy **Client Secret** into the **API Secret** field in Plumber\
     ![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FejcP4b5lPoChRLQoxKJ7%2Fimage.png?alt=media\&token=a9167b6f-0caf-4aa5-9dbf-bb0e4755307d)\
     ![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2Fesrp7vfHzzD1v7SI47PB%2Fimage.png?alt=media\&token=0f12359b-d1ff-43bb-ac90-26bed6f6bd2f)
9. Click on **Submit.**
10. A new window with the Slack consent screen will pop up.
11. Click on **Allow**.\
    ![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FZqlkcME733ycjWSLPzbX%2Fimage.png?alt=media\&token=13d7f699-db9e-4e1b-89e5-fc6b52e45407)
12. Your **Slack** integration is now ready!



### Send a message to a channel

#### 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:&#x20;

1. start by typing `/display ids` into any conversation on Slack.
2.  Select the built-in shortcut `Display IDs`

    <figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FxyBliopVUmDpoNj7By0b%2FScreenshot%202024-02-06%20at%209.07.23%E2%80%AFPM.png?alt=media&#x26;token=0fdcda6d-15ee-461f-98df-9f3424d86636" alt=""><figcaption></figcaption></figure>
3. Select the private channel in the dropdown as shown in the screenshot below. ![](https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FFmdjrEdfty0XoV2T7Xyy%2Fslack%20id%20selector.png?alt=media\&token=2391a3ad-a2e7-4e6c-b1d8-362203d4d2f5)
4.  Copy and paste the selected conversation/channel ID into Plumber and click Use: \<CHANNEL\_ID>

    <figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FmR9q0XxSKr6Uo1ldTcL7%2Fimage.png?alt=media&#x26;token=0a838548-06be-4fcb-b972-c57cf99e6ffe" alt=""><figcaption></figcaption></figure>
5.  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.

    <figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2F4gQPU281b7E0AHo6yXdz%2Fsend%20private%20channel.png?alt=media&#x26;token=72862265-1634-4704-bcde-88787b5c683d" alt=""><figcaption></figcaption></figure>

#### Message text

To [**mention users**](https://api.slack.com/reference/surfaces/formatting#mentioning-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**](https://api.slack.com/reference/surfaces/formatting#mentioning-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.&#x20;

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FtLYgmnvdGpcVxpfk4Oj4%2Fimage.png?alt=media&#x26;token=f0f559a9-699f-4c30-af4b-bd1114d5c9ce" alt="" width="350"><figcaption><p>The first message is sent with <code>Send as a bot?</code> set to false. The next is set to true.</p></figcaption></figure>

