From 35107c0a9d54d20fa6be42a1221460a6f884bc59 Mon Sep 17 00:00:00 2001 From: KS Jannette Date: Sun, 1 Mar 2026 10:25:56 -0500 Subject: [PATCH] Add notification platform setup guides to README Made-with: Cursor --- README.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 76 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f45210..b4d0faa 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,82 @@ To receive alerts via Telegram, you need to create a bot and get your chat ID. --- -*Guides for Discord, Slack, and Email coming soon.* +### Discord + +To receive alerts in a Discord channel, you need to create a webhook. + +#### 1. Create a Discord Webhook + +1. Open **Discord** and navigate to the server where you want to receive alerts. +2. Go to the channel you want alerts posted in (or create a new one, e.g. `#koin-alerts`). +3. Click the **gear icon** next to the channel name to open **Channel Settings**. +4. Go to **Integrations** > **Webhooks**. +5. Click **New Webhook**. +6. Give it a name (e.g. `Koin Ping`) and click **Copy Webhook URL**. + + The URL will look like: `https://discord.com/api/webhooks/123456789/AbCdEfGhIjKl...` + +#### 2. Save in Koin Ping + +1. Go to the **Alerts** page in Koin Ping. +2. In the **Notification Settings** panel, find the **Discord** section. +3. Paste your **Webhook URL** into the field. +4. Click **Save Settings**. +5. Click **Test All Channels** to verify — you should see a test message appear in your Discord channel. + +--- + +### Slack + +To receive alerts in a Slack channel, you need to create an Incoming Webhook. + +#### 1. Create a Slack App with Incoming Webhooks + +1. Go to [https://api.slack.com/apps](https://api.slack.com/apps) and click **Create New App**. +2. Choose **From scratch**, give it a name (e.g. `Koin Ping`), and select your workspace. +3. In the app settings, go to **Incoming Webhooks** in the left sidebar. +4. Toggle **Activate Incoming Webhooks** to **On**. +5. Click **Add New Webhook to Workspace**. +6. Select the channel where you want alerts posted (e.g. `#koin-alerts`) and click **Allow**. +7. Copy the **Webhook URL** — it will start with `https://hooks.slack.com/services/...` + +#### 2. Save in Koin Ping + +1. Go to the **Alerts** page in Koin Ping. +2. In the **Notification Settings** panel, find the **Slack** section. +3. Paste your **Webhook URL** into the field. +4. Click **Save Settings**. +5. Click **Test All Channels** to verify — you should see a test message appear in your Slack channel. + +--- + +### Email + +Koin Ping sends email alerts and digests via [Resend](https://resend.com). To enable email notifications, the application owner must configure a Resend account and verified sending domain. + +#### For Application Owners (Deployment Setup) + +1. Create an account at [resend.com](https://resend.com). +2. Go to [resend.com/domains](https://resend.com/domains) and add your sending domain. +3. Add the DNS records Resend provides (SPF, DKIM, etc.) to your domain's DNS settings. +4. Once verified, create an API key at [resend.com/api-keys](https://resend.com/api-keys). +5. Set the following in your `.env` file: + + ``` + RESEND_API_KEY=re_your_api_key_here + EMAIL_FROM=Your App + ``` + +6. Restart the API server and poller to pick up the changes. + +#### For Users + +1. Go to the **Alerts** page in Koin Ping. +2. In the **Notification Settings** panel, find the **Email** section. +3. Enter the email address where you want to receive alerts. +4. Click **Save Settings**. +5. Click **Verify Email** to receive a confirmation message. +6. Click **Test All Channels** to verify — you should receive a test alert at your email address. ## License