diff --git a/integrations/support/overview.mdx b/integrations/support/overview.mdx index 21892b0c1..9bbc70de4 100644 --- a/integrations/support/overview.mdx +++ b/integrations/support/overview.mdx @@ -31,6 +31,19 @@ description: "Integrate with a support widget" } horizontal +> + + + + + + + +} +horizontal > @@ -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" + } } -``` +``` \ No newline at end of file diff --git a/integrations/support/slack.mdx b/integrations/support/slack.mdx new file mode 100644 index 000000000..189166d0d --- /dev/null +++ b/integrations/support/slack.mdx @@ -0,0 +1,44 @@ +--- +title: "Slack" +--- + +Add the following to your `docs.json` file to add a [Slack](https://slack.com) integration. + + + +```json Integration options in docs.json +"integrations": { + "slack": { + "webhookUrl": "WEBHOOK_URL" + } +} +``` + +```json Example +"integrations": { + "slack": { + "webhookUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX" + } +} +``` + + + +## 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 + +## What gets sent to Slack + +When configured, your documentation will send notifications to your specified Slack channel for: + +- Page views and user engagement +- Feedback submissions (thumbs up/down) +- Search queries and results +- Assistant interactions + +This helps you stay informed about how users are interacting with your documentation. \ No newline at end of file