Skip to content

Commit 946c666

Browse files
committed
Add webhook documentation
1 parent a472b25 commit 946c666

File tree

6 files changed

+67
-2
lines changed

6 files changed

+67
-2
lines changed

crowdsec-docs/sidebarsUnversioned.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,11 @@ module.exports = {
284284
label: "Slack",
285285
id: "console/notification_integrations/slack",
286286
},
287+
{
288+
type: "doc",
289+
label: "Webhook",
290+
id: "console/notification_integrations/webhook",
291+
},
287292
],
288293
},
289294
],
105 KB
Loading
46.1 KB
Loading
109 KB
Loading

crowdsec-docs/unversioned/console/notification_integrations/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Discover all the available notification integrations in CrowdSec. Each integrati
1010
## Available Integrations
1111

1212
- [Slack](/u/console/notification_integrations/slack)
13+
- [Webhook](/u/console/notification_integrations/webhook)
1314
- Coming soon: Discord
14-
- Coming soon: Webhook
1515
- Coming soon: Microsoft Teams
1616

1717
## How to use notification integrations
1818

1919
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.
2020
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.)
2121

22-
## Available Events
22+
## Available Events
2323

2424
The following events are available for notification integrations:
2525

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
id: webhook
3+
title: Webhook
4+
---
5+
6+
7+
## Install the webhook integration
8+
9+
Installing the webhook integration allow you to configure any webhook URL when configuring your notification rule.
10+
11+
1. In the [CrowdSec Console](https://app.crowdsec.net), navigate to **Settings > Integrations** and then select **Activate** in the Webhook row.
12+
13+
![](/img/console/notification_integrations/activate-webhook.png)
14+
15+
2. You should be redirected to the Webhook integration page. You can now create a notification rule by navigating to the **Rules** tab.
16+
17+
![](/img/console/notification_integrations/webhook-overview-tab.png)
18+
19+
## Create a notification rule
20+
21+
1. In the [CrowdSec Console](https://app.crowdsec.net), navigate to **Settings > Integrations > Webhook** go to the Rules tab and click on **Add rule**.
22+
23+
2. Follow the steps in the [Create a notification rule](/u/console/notification_integrations/rule) documentation to create your rule.
24+
25+
26+
## Configure webhook
27+
28+
### Authentication
29+
30+
For the authentication part, the webhook integration support the following methods:
31+
32+
- `HTTP Header name` / `HTTP Header value` : You can provide a specific header name with a specific header value for the webhook integration to authenticate against your webhook URL
33+
- [`Basic auth`](https://en.wikipedia.org/wiki/Basic_access_authentication) : You can use [`basic auth`](https://en.wikipedia.org/wiki/Basic_access_authentication) (user/password) for the webhook integration to authenticate against your webhook URL
34+
35+
36+
### Configuration
37+
38+
You can configure your custom Webhook URL and authentication by adding a new destination in your notification rule:
39+
40+
:::info
41+
42+
If the HTTPs endpoint certificate is not valid, you can choose to disable SSL verification.
43+
44+
:::
45+
46+
![Webhook destination](/img/console/notification_integrations/webhook-destination.png)
47+
48+
49+
## Troubleshooting
50+
51+
### Network error
52+
53+
If you are unable to ping your webhook URL, this may be because of networking problem.
54+
55+
The webhook integration is allowed to send HTTP request on the following port:
56+
57+
- `80`
58+
- `8080`
59+
- `443`
60+
- `8443`

0 commit comments

Comments
 (0)