You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 5, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: site/content/docs/integrations/slack.md
+207Lines changed: 207 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,3 +33,210 @@ We provide a lot of information in the initial Slack message including links to
33
33
From the recovered Slack message, you can see the timestamp as well as a link to the check itself.
34
34
35
35

36
+
37
+
---
38
+
39
+
## Custom Slack Webhook Integration (Advanced)
40
+
41
+
For advanced users who need more control over the Slack alert format and content, you can use a **Webhook Alert Channel** in Checkly to send fully customized messages to Slack.
42
+
43
+
This approach is ideal when the native Slack integration does not meet your formatting or dynamic content needs.
44
+
45
+
### Setup Overview
46
+
47
+
You will be using a `WebhookAlertChannel` construct with a Slack Incoming WebHook URL and a custom payload template. This setup allows you to:
48
+
49
+
- Control Slack message formatting using Slack's [Block Kit](https://api.slack.com/block-kit)
50
+
- Show detailed check information such as:
51
+
- Check name and ID
52
+
- Run location and start time
53
+
- Response time
54
+
- Error messages (on failure)
55
+
- Recovery or degraded state
56
+
- Link directly to a runbook or documentation for the failing check
57
+
58
+
### Setting It Up
59
+
60
+
1.**Create a Slack Webhook**
61
+
- Follow Step 1 from the main section above to generate a Webhook URL in Slack.
62
+
- Choose the bot name and icon for your alerts.
63
+
64
+
2.**Create a Webhook Alert Channel in Checkly**
65
+
- Go to **Alert Settings > Add More Channels > Webhook**
66
+
- Fill in the following:
67
+
-**Name**: e.g. `Custom Slack Alerts`
68
+
-**URL**: Paste the Slack Webhook URL
69
+
-**Method**: `POST`
70
+
-**Send Alerts for**: Enable `Failure`, `Recovery`, and `Degraded`
71
+
-**SSL Expiry**: Optional, not supported in this template
72
+
-**Template**: See below
73
+
74
+
3.**Customize the Template**
75
+
76
+
The following template uses conditional logic (`{{#if}}`) to change the message depending on the alert type:
> Be sure to update or remove the placeholder button links to Runbooks, OTel provider and anything else that is not needed for your use case.
236
+
237
+
>[!NOTE]
238
+
> Be sure each check mapped in the runbook logic has a corresponding URL. If a match isn’t found, fallback to a default documentation page.
239
+
240
+
### Testing the Webhook limitations
241
+
* You cannot use the Test Webhook button in Checkly for this template, as Slack requires valid payload structure and the test payload lacks real check data.
242
+
* To test, trigger a real alert by adjusting a check so it fails, degrades, and recovers.
0 commit comments