Skip to content

Commit a472b25

Browse files
committed
feat(notification integration): 📝 notification integration doc
1 parent 376474a commit a472b25

File tree

12 files changed

+3589
-1406
lines changed

12 files changed

+3589
-1406
lines changed

crowdsec-docs/package-lock.json

Lines changed: 3420 additions & 1406 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

crowdsec-docs/sidebarsUnversioned.js

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,27 @@ module.exports = {
265265
label: "Service API 🏅",
266266
href: "/u/service_api/getting_started",
267267
},
268+
{
269+
type: "category",
270+
label: "Notification integrations 🏅",
271+
items: [
272+
{
273+
type: "doc",
274+
label: "Overview",
275+
id: "console/notification_integrations/overview",
276+
},
277+
{
278+
type: "doc",
279+
label: "Notification Rule",
280+
id: "console/notification_integrations/rule",
281+
},
282+
{
283+
type: "doc",
284+
label: "Slack",
285+
id: "console/notification_integrations/slack",
286+
},
287+
],
288+
},
268289
],
269290
remediationSideBar: [
270291
{
84.4 KB
Loading
56.1 KB
Loading
56.6 KB
Loading
113 KB
Loading
19 KB
Loading
44.2 KB
Loading
35.8 KB
Loading
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
id: overview
3+
title: Overview
4+
---
5+
6+
Discover all the available notification integrations in CrowdSec. Each integration is designed to help you receive alerts and notifications to various platforms, ensuring you stay informed about security events and incidents. Available [here](https://app.crowdsec.net/settings/integrations).
7+
8+
> 🌟 Premium feature. CrowdSec let you be linked to any notification integration. However, you need to be a ⭐ Premium organization to unlock the full potential of the notification integrations.
9+
10+
## Available Integrations
11+
12+
- [Slack](/u/console/notification_integrations/slack)
13+
- Coming soon: Discord
14+
- Coming soon: Webhook
15+
- Coming soon: Microsoft Teams
16+
17+
## How to use notification integrations
18+
19+
1. **Link your integration**: Navigate to the **Settings > Integrations** section in the CrowdSec Console and select the integration you want to link. Follow the instructions provided for each integration.
20+
2. [**Create a notification rule**](/u/console/notification_integrations/rule): Once your integration is linked, navigate to the **Rules** tab of the integration page. Here, you can create notification rules based on specific events or conditions. ([See the documentation](/u/console/notification_integrations/rule) for more details on creating rules.)
21+
22+
## Available Events
23+
24+
The following events are available for notification integrations:
25+
26+
**Threat Hunting**
27+
28+
| Name | Description |
29+
|------|-------------|
30+
Is Attacking | An attack has been detected from your Security Engine. |
31+
Is Attacked | Your organization is being attacked. |
32+
Alert Triggered | An alert has been triggered. |
33+
34+
35+
36+
**Stack - Management**
37+
38+
| Name | Description |
39+
|------|-------------|
40+
Security Engine Enrolled | A new Security Engine has been enrolled. |
41+
Security Engine Unenrolled | A Security Engine has been unenrolled. |
42+
Security Engine Long Pending Enroll | A Security Engine has been pending for a long time. |
43+
44+
**Stack - Monitoring**
45+
46+
| Name | Description |
47+
|------|-------------|
48+
Firewall Integration Offline | A firewall integration is offline. |
49+
Log Processor No Alert | A log processor has not sent any alerts for 48h. |
50+
Log Processor Offline | A log processor is offline. |
51+
Remediation Component Integration Offline | A remediation component integration is offline. |
52+
Remediation Component Offline | A remediation component is offline. |
53+
CrowdSec Stack Component Outdated | A CrowdSec stack component is outdated (Security Engine, Log Processor, Remediation component). |
54+
Security Engine No Alerts | A Security Engine has not sent any alerts for 48h. |
55+
Security Engine Offline | A Security Engine is offline. |
56+
57+
**Admin**
58+
59+
| Name | Description |
60+
|------|-------------|
61+
API Key Expired | An API key has expired. |
62+
Payment Failed | A payment has failed. |
63+
64+
65+
## Examples

0 commit comments

Comments
 (0)