Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions integrations/support/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ description: "Integrate with a support widget"
</svg>
}
horizontal
>
</Card>
<Card
href="/integrations/support/slack"
title="Slack"
icon={<svg className="h-6 w-6" width="127" height="127" viewBox="0 0 127 127" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M27.2 80.3c0 7.3-5.9 13.2-13.2 13.2S.8 87.6.8 80.3s5.9-13.2 13.2-13.2h13.2v13.2zm6.6 0c0-7.3 5.9-13.2 13.2-13.2s13.2 5.9 13.2 13.2v33c0 7.3-5.9 13.2-13.2 13.2s-13.2-5.9-13.2-13.2v-33z" fill="#E01E5A"/>
<path d="M47 27.2c-7.3 0-13.2-5.9-13.2-13.2S39.7.8 47 .8s13.2 5.9 13.2 13.2v13.2H47zm0 6.6c7.3 0 13.2 5.9 13.2 13.2s-5.9 13.2-13.2 13.2H14c-7.3 0-13.2-5.9-13.2-13.2S6.7 33.8 14 33.8h33z" fill="#36C5F0"/>
<path d="M99.8 47c0-7.3 5.9-13.2 13.2-13.2s13.2 5.9 13.2 13.2-5.9 13.2-13.2 13.2H99.8V47zm-6.6 0c0 7.3-5.9 13.2-13.2 13.2S66.8 54.3 66.8 47V14c0-7.3 5.9-13.2 13.2-13.2S93.2 6.7 93.2 14v33z" fill="#2EB67D"/>
<path d="M80 99.8c7.3 0 13.2 5.9 13.2 13.2s-5.9 13.2-13.2 13.2-13.2-5.9-13.2-13.2V99.8H80zm0-6.6c-7.3 0-13.2-5.9-13.2-13.2S72.7 66.8 80 66.8h33c7.3 0 13.2 5.9 13.2 13.2S120.3 93.2 113 93.2H80z" fill="#ECB22E"/>
</svg>
}
horizontal
>
</Card>
</CardGroup>
Expand All @@ -42,6 +55,9 @@ Integrate customer support widgets into your documentation. Add the `integration
```json
"integrations": {
"intercom": "APP_ID",
"frontchat": "CHAT_ID"
"frontchat": "CHAT_ID",
"slack": {
"webhookUrl": "WEBHOOK_URL"
}
}
```
```
44 changes: 44 additions & 0 deletions integrations/support/slack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: "Slack"
---

Add the following to your `docs.json` file to add a [Slack](https://slack.com) integration.

<CodeGroup>

```json Integration options in docs.json
"integrations": {
"slack": {
"webhookUrl": "WEBHOOK_URL"
}
}
```

```json Example
"integrations": {
"slack": {
"webhookUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
}
}
```

</CodeGroup>

## Setting up your Slack webhook

1. Go to your Slack workspace and navigate to **Apps**
2. Search for and install the **Incoming Webhooks** app
3. Click **Add to Slack** and select the channel where you want to receive notifications
4. Copy the webhook URL provided by Slack
5. Add the webhook URL to your `docs.json` file as shown above

Check warning on line 33 in integrations/support/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/support/slack.mdx#L33

Use 'preceding' instead of 'above'.

## What gets sent to Slack

When configured, your documentation will send notifications to your specified Slack channel for:

Check warning on line 37 in integrations/support/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/support/slack.mdx#L37

Avoid using 'will'.

- Page views and user engagement
- Feedback submissions (thumbs up/down)

Check warning on line 40 in integrations/support/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/support/slack.mdx#L40

Use parentheses judiciously.
- Search queries and results
- Assistant interactions

This helps you stay informed about how users are interacting with your documentation.
Loading