Skip to content

Commit 47699ac

Browse files
Update integrations/support/slack.mdx
1 parent 25c44fe commit 47699ac

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

integrations/support/slack.mdx

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: "Slack"
3+
---
4+
5+
Add the following to your `docs.json` file to add a [Slack](https://slack.com) integration.
6+
7+
<CodeGroup>
8+
9+
```json Integration options in docs.json
10+
"integrations": {
11+
"slack": {
12+
"webhookUrl": "WEBHOOK_URL"
13+
}
14+
}
15+
```
16+
17+
```json Example
18+
"integrations": {
19+
"slack": {
20+
"webhookUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
21+
}
22+
}
23+
```
24+
25+
</CodeGroup>
26+
27+
## Setting up your Slack webhook
28+
29+
1. Go to your Slack workspace and navigate to **Apps**
30+
2. Search for and install the **Incoming Webhooks** app
31+
3. Click **Add to Slack** and select the channel where you want to receive notifications
32+
4. Copy the webhook URL provided by Slack
33+
5. Add the webhook URL to your `docs.json` file as shown above
34+
35+
## What gets sent to Slack
36+
37+
When configured, your documentation will send notifications to your specified Slack channel for:
38+
39+
- Page views and user engagement
40+
- Feedback submissions (thumbs up/down)
41+
- Search queries and results
42+
- Assistant interactions
43+
44+
This helps you stay informed about how users are interacting with your documentation.

0 commit comments

Comments
 (0)