Skip to content

Commit 04000cd

Browse files
committed
feat: slack docs
1 parent 1750b1f commit 04000cd

File tree

1 file changed

+6
-10
lines changed
  • src/administration-guide/notifications

1 file changed

+6
-10
lines changed

src/administration-guide/notifications/slack.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,22 @@ To set up Slack notifications, you need to create a webhook URL that connects Se
1111

1212
## Creating Slack webhook
1313

14-
### Step 1. Open Slack API Settings
14+
### Step 1. Open Slack API settings
1515

1616
1. Go to [https://api.slack.com/apps](https://api.slack.com/apps).
1717
2. Click **Create New App** → choose **From Scratch**.
1818
3. Give your app a name (e.g., `Semaphore Bot`) and select your **Slack workspace**.
1919

2020
---
2121

22-
### Step 2. Enable Incoming Webhooks
22+
### Step 2. Enable incoming webhooks
2323

2424
1. Inside the app settings, go to **Features → Incoming Webhooks**.
2525
2. Switch **ctivate Incoming Webhooks****On**.
2626

2727
---
2828

29-
### Step 3. Create a Webhook URL
29+
### Step 3. Create a webhook URL
3030

3131
1. Click **dd New Webhook to Workspace**.
3232
2. Select the xxchannelxx where messages should be sent.
@@ -39,7 +39,7 @@ To set up Slack notifications, you need to create a webhook URL that connects Se
3939

4040
---
4141

42-
### Step 4. Test Your Webhook
42+
### Step 4. Test your webhook
4343

4444
Use `curl` to test:
4545

@@ -56,11 +56,9 @@ If everything is set up, you’ll see the message in the selected Slack channel.
5656

5757
Once you have your Slack webhook URL, you can configure Semaphore to send notifications in several ways:
5858

59-
### Configuration Methods
60-
6159
You can enable Slack notifications using either configuration files or environment variables.
6260

63-
#### Method 1: Configuration File
61+
### Method 1: Configuration file
6462

6563
Add the following settings to your Semaphore configuration file:
6664

@@ -76,12 +74,10 @@ Add the following settings to your Semaphore configuration file:
7674
}
7775
```
7876

79-
#### Method 2: Environment Variables
77+
### Method 2: Environment variables
8078

8179
Alternatively, you can use environment variables to configure Slack notifications. This method is particularly useful for containerized deployments or when you want to keep sensitive information separate from configuration files.
8280

83-
Environemnt variables:
84-
8581
```
8682
SEMAPHORE_SLACK_ALERT=True
8783
SEMAPHORE_SLACK_URL=https://hooks.slack.com/services/xxxxxxxxxxx/xxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx

0 commit comments

Comments
 (0)