diff --git a/pages/docs/alerts/features/_meta.json b/pages/docs/alerts/features/_meta.json index d5a4505..62463d1 100644 --- a/pages/docs/alerts/features/_meta.json +++ b/pages/docs/alerts/features/_meta.json @@ -1,6 +1,7 @@ { "overview-alert": "Overview", "target-group": "Target Groups", + "slack-webhook-setup": "Slack Webhook Setup", "system-alert": "Alerts Routing", "history-alert": "History" } diff --git a/pages/docs/alerts/features/slack-webhook-setup.mdx b/pages/docs/alerts/features/slack-webhook-setup.mdx new file mode 100644 index 0000000..99fc158 --- /dev/null +++ b/pages/docs/alerts/features/slack-webhook-setup.mdx @@ -0,0 +1,89 @@ +--- +title: Create an Incoming Webhook on Slack +--- + +import Image from "../../../../components/Image"; +import { Callout } from "nextra/components"; +import { Steps } from 'nextra/components' + +# Create an Incoming Webhook on Slack + +Incoming Webhooks let you send messages from external systems directly into a Slack channel. This guide will walk you through every step, from setting up your Slack app to testing your webhook and adding it to the Skyu console. + +--- + +# Steps to Create an Incoming Webhook + + + +### Create a Channel for Alerts +1. Open Slack. +2. In the sidebar, next to **Channels**, click the **+** button. +3. Select **Create a channel**. +4. Give your channel a descriptive name (e.g., `#alerts` or `#skyu-notifications`). +5. Set the channel to **private** or **public** as needed. +6. Click **Create**. + + +You can use an existing channel if you prefer, but creating a dedicated channel helps keep alerts organized. + + +--- + +### Create a Slack App + +1. Go to [Slack API: Create New App](https://api.slack.com/apps/new). +2. Select **From scratch**. + Slack Create App from Scratch +3. Enter a name for your app (e.g., `Skyu Alerts`). +4. Choose the workspace where you want to install the app. + Slack Select Workspace +5. Click **Create App**. + +--- + +### Add Description and Iconc (Optional) + +1. In your app’s **Basic Information** page, you can add: + - **Short Description:** Explain what your app does. + - **App Icon:** Upload a custom image to make your app easily recognizable in Slack. + Slack Add App Description and Icon +2. Click **Save Changes**. + +--- + +### Enable Incoming Webhooks + +1. In the left sidebar, click **Incoming Webhooks** under **Features**. +2. Toggle the switch to **On** to enable incoming webhooks. + Slack Enable Incoming Webhooks +3. Read the information provided to understand how webhooks work. + +--- + +### Add a New Webhook to Your Workspace + +1. On the **Incoming Webhooks** page, scroll down to **Webhook URLs for Your Workspace**. +2. Click **Add New Webhook to Workspace**. + Slack Add New Webhook to Workspace +3. Slack will prompt you to choose a channel. Select the channel you created in Step 1. + Slack Select Channel for Webhook +4. Click **Allow** to grant the app permission to post in that channel. +5. You’ll be redirected back to the webhooks page, where you’ll see your new webhook URL listed under **Webhook URLs for Your Workspace**. + +--- + +### Copy the Webhook URL + +1. The webhook URL will look like this: + `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX` +2. Click **Copy** next to the URL. + + +Keep this URL secure. Anyone with this link can post messages to your Slack channel. + + +--- + +**Congratulations!** You’ve successfully set up an Incoming Webhook for Slack. Your alerts will now flow directly into your chosen channel, keeping your team informed and responsive. Great job! + \ No newline at end of file diff --git a/pages/docs/alerts/features/target-group.mdx b/pages/docs/alerts/features/target-group.mdx index f9990ae..3a20eb7 100644 --- a/pages/docs/alerts/features/target-group.mdx +++ b/pages/docs/alerts/features/target-group.mdx @@ -36,7 +36,7 @@ When linking a Slack channel, you are required to provide the following details: | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | | Group Name | Name of the Target Group. This is for your reference. | | Alert Channel | Select `Slack` | -| Slack URL | Your Slack channel webhook URL. (Please refer [Create an Incoming Webhook](https://api.slack.com/messaging/webhooks#getting_started)) | +| Slack URL | Your Slack channel webhook URL. (Please refer [Create an Incoming Webhook](https://www.docs.skyu.io/docs/alerts/features/slack-webhook-setup) | | Specify Email Recipients | Email addresses of recipients designated to receive alert notifications. (Optional) | Finally select Save button to save it. diff --git a/public/assets/images/slack/slack-1.png b/public/assets/images/slack/slack-1.png new file mode 100644 index 0000000..3b5c83e Binary files /dev/null and b/public/assets/images/slack/slack-1.png differ diff --git a/public/assets/images/slack/slack-2.png b/public/assets/images/slack/slack-2.png new file mode 100644 index 0000000..2f924ba Binary files /dev/null and b/public/assets/images/slack/slack-2.png differ diff --git a/public/assets/images/slack/slack-3.png b/public/assets/images/slack/slack-3.png new file mode 100644 index 0000000..440daa8 Binary files /dev/null and b/public/assets/images/slack/slack-3.png differ diff --git a/public/assets/images/slack/slack-4.png b/public/assets/images/slack/slack-4.png new file mode 100644 index 0000000..e5f07af Binary files /dev/null and b/public/assets/images/slack/slack-4.png differ diff --git a/public/assets/images/slack/slack-5.png b/public/assets/images/slack/slack-5.png new file mode 100644 index 0000000..709af09 Binary files /dev/null and b/public/assets/images/slack/slack-5.png differ diff --git a/public/assets/images/slack/slack-6.png b/public/assets/images/slack/slack-6.png new file mode 100644 index 0000000..b2d1bb6 Binary files /dev/null and b/public/assets/images/slack/slack-6.png differ diff --git a/public/assets/images/slack/slack-7.png b/public/assets/images/slack/slack-7.png new file mode 100644 index 0000000..d8f8119 Binary files /dev/null and b/public/assets/images/slack/slack-7.png differ diff --git a/public/assets/images/slack/slack-8.png b/public/assets/images/slack/slack-8.png new file mode 100644 index 0000000..64f9a50 Binary files /dev/null and b/public/assets/images/slack/slack-8.png differ