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
12 changes: 8 additions & 4 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,8 @@
"pages": [
"integrations/support/overview",
"integrations/support/intercom",
"integrations/support/front"
"integrations/support/front",
"integrations/support/slack"
]
},
{
Expand Down Expand Up @@ -484,7 +485,8 @@
"pages": [
"fr/integrations/support/overview",
"fr/integrations/support/intercom",
"fr/integrations/support/front"
"fr/integrations/support/front",
"integrations/support/slack"
]
},
{
Expand Down Expand Up @@ -751,7 +753,8 @@
"pages": [
"es/integrations/support/overview",
"es/integrations/support/intercom",
"es/integrations/support/front"
"es/integrations/support/front",
"integrations/support/slack"
]
},
{
Expand Down Expand Up @@ -1018,7 +1021,8 @@
"pages": [
"zh/integrations/support/overview",
"zh/integrations/support/intercom",
"zh/integrations/support/front"
"zh/integrations/support/front",
"integrations/support/slack"
]
},
{
Expand Down
15 changes: 14 additions & 1 deletion integrations/support/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ description: "Integrate with a support widget"
</svg>
}
horizontal
>
</Card>
<Card
href="/integrations/support/slack"
title="Slack"
icon={<svg className="h-6 w-6" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M5.042 15.165a2.528 2.528 0 0 1-2.52 2.523A2.528 2.528 0 0 1 0 15.165a2.527 2.527 0 0 1 2.522-2.52h2.52v2.52zM6.313 15.165a2.527 2.527 0 0 1 2.521-2.52 2.527 2.527 0 0 1 2.521 2.52v6.313A2.528 2.528 0 0 1 8.834 24a2.528 2.528 0 0 1-2.521-2.522v-6.313zM8.834 5.042a2.528 2.528 0 0 1-2.521-2.52A2.528 2.528 0 0 1 8.834 0a2.528 2.528 0 0 1 2.521 2.522v2.52H8.834zM8.834 6.313a2.528 2.528 0 0 1 2.521 2.521 2.528 2.528 0 0 1-2.521 2.521H2.522A2.528 2.528 0 0 1 0 8.834a2.528 2.528 0 0 1 2.522-2.521h6.312zM18.956 8.834a2.528 2.528 0 0 1 2.522-2.521A2.528 2.528 0 0 1 24 8.834a2.528 2.528 0 0 1-2.522 2.521h-2.522V8.834zM17.688 8.834a2.528 2.528 0 0 1-2.522 2.521 2.528 2.528 0 0 1-2.521-2.521V2.522A2.528 2.528 0 0 1 15.166 0a2.528 2.528 0 0 1 2.522 2.522v6.312zM15.166 18.956a2.528 2.528 0 0 1 2.522 2.522A2.528 2.528 0 0 1 15.166 24a2.528 2.528 0 0 1-2.521-2.522v-2.522h2.521zM15.166 17.688a2.528 2.528 0 0 1-2.521-2.523 2.528 2.528 0 0 1 2.521-2.52h6.312A2.528 2.528 0 0 1 24 15.165a2.528 2.528 0 0 1-2.522 2.523h-6.312z" fill="#E01E5A"/>
</svg>}
horizontal
>
</Card>
</CardGroup>
Expand All @@ -42,6 +51,10 @@ Integrate customer support widgets into your documentation. Add the `integration
```json
"integrations": {
"intercom": "APP_ID",
"frontchat": "CHAT_ID"
"frontchat": "CHAT_ID",
"slack": {
"workspaceId": "WORKSPACE_ID",
"channelId": "CHANNEL_ID"
}
}
```
37 changes: 37 additions & 0 deletions integrations/support/slack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Slack"
---

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

<CodeGroup>

```json Integration options in docs.json
"integrations": {
"slack": {
"workspaceId": "WORKSPACE_ID",
"channelId": "CHANNEL_ID"
}
}
```

```json Example
"integrations": {
"slack": {
"workspaceId": "T1234567890",
"channelId": "C1234567890"
}
}
```

</CodeGroup>

## Configuration

To set up Slack integration:

1. **Get your Workspace ID**: Find your Slack workspace ID in your Slack URL (e.g., `https://your-workspace.slack.com` where `your-workspace` is the workspace ID)

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 parentheses judiciously.

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 'where's' instead of 'where is'.

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 'for example' instead of 'e.g.'.
2. **Get your Channel ID**: Right-click on the channel name in Slack and select "Copy link" - the channel ID is the last part of the URL after the last `/`

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/support/slack.mdx#L34

Use 'click' or 'click in' instead of 'click on'.
3. **Add the configuration** to your `docs.json` file as shown above

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/support/slack.mdx#L35

Use 'preceding' instead of 'above'.

The Slack integration will add a widget that allows users to connect with your team directly through Slack.

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'.
Loading