Skip to content

Commit 25e4bda

Browse files
Marcio/Notification docs (#1612)
* Created notification folder in fundamentals * added front matter * added content to index * added content * created pages and content * changed name of file * changed content * changed start image * changed wording and image * changed img * deleted extra image and edited content * refined text * Update products/fundamentals/src/content/notifications/index.md Co-authored-by: abracchi-tw <[email protected]> * Update products/fundamentals/src/content/notifications/assessing-notifications.md Co-authored-by: abracchi-tw <[email protected]> * Update products/fundamentals/src/content/notifications/configure-create/create-notifications.md Co-authored-by: abracchi-tw <[email protected]> * Update products/fundamentals/src/content/notifications/configure-create/create-notifications.md Co-authored-by: abracchi-tw <[email protected]> * applied Alice suggestions * added Alice suggestions * added explanation to notification options * corrected typing error * moved created webhooks to the create page added how to created a pagerduty added how to edit pagerduty and wenhooks * changed tables to list of notifications available * moved what to do when receiving notifications same page that describes what is available * deleted extra page * added info to overview about meaning of notifications edits througout text to make it clearer * implemented Pedro's suggestions created _partials * implementd Pedro's suggestions * implemented pedro's suggestion Co-authored-by: abracchi-tw <[email protected]>
1 parent 16b77e5 commit 25e4bda

File tree

11 files changed

+479
-0
lines changed

11 files changed

+479
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
No action needed. Refer to [Understanding Cloudflare DDoS alerts](https://support.cloudflare.com/hc/articles/360053216191) for more information.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Refer to [Troubleshooting Cloudflare 5XX errors](https://support.cloudflare.com/hc/articles/115003011431) to learn how to troubleshoot these errors.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
You only need to take action if notified that you have a certificate that failed. You can find the reasons why a certificate is not being issued in [Troubleshooting SSL errors](https://support.cloudflare.com/hc/articles/200170566#h_c1a6e78e-150d-4db6-89ab-eec7cb1ab03f).
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
order: 0
3+
pcx-content: how-to
4+
---
5+
6+
# Create a Notification
7+
8+
1. Sign in to your [Cloudflare dashboard](https://dash.cloudflare.com/login).
9+
1. Go to **Notifications**.
10+
1. Click **Add**.
11+
1. Click **Select** on the Notification you want to enable. The list of Notifications available depends on the [type of account you have](/notifications/notification-available).
12+
1. Give the Notification a name to identify it.
13+
1. Add a way to be notified, like an email address. Professional and Business plans will have access to other options such as configuring PagerDuty or accessing webhooks.
14+
1. Click **Create**.
15+
16+
This will take you back to your list of Notifications, where the new Notification will appear as **Enabled**.
17+
18+
## PagerDuty
19+
20+
Professional plans or higher can configure PagerDuty to receive notifications about their Cloudflare account. If you do not have a PagerDuty account, see [how to create an account](https://support.pagerduty.com/docs/quick-start-guide) in PagerDuty's documentation.
21+
22+
1. Sign in to your [Cloudflare dashboard](https://dash.cloudflare.com/login).
23+
1. Go to **Notifications**.
24+
1. Click **Destinations** on the left side of your dashboard.
25+
1. In the **Connected notification services** card, click **Connect**.
26+
1. Log in to your PagerDuty account to connect it to your Cloudflare account.
27+
1. Select the services you want to use and click **Connect**.
28+
1. The browser will navigate back to your Cloudflare dashboard. Click **Continue**.
29+
30+
Your new connected PagerDuty will appear in the **Connected notification services** card.
31+
32+
## Webhooks to external services
33+
34+
There are a variety of services you can connect to Cloudflare using webhooks to receive Notifications from your Cloudflare account. Here are some of the most popular services you can connect to your Cloudflare account:
35+
36+
* [Jira](https://developer.atlassian.com/server/jira/platform/webhooks/)
37+
* [Slack](https://api.slack.com/messaging/webhooks)
38+
* [Google Chat](https://developers.google.com/chat/how-tos/webhooks)
39+
* [DataDog](https://docs.datadoghq.com/developers/guide/calling-on-datadog-s-api-with-the-webhooks-integration/)
40+
* [OpsGenie](https://docs.opsgenie.com/docs/integration-api)
41+
42+
After configuring the external service you want to connect to, set up webhooks in your Cloudflare dashboard:
43+
44+
1. Sign in to your [Cloudflare dashboard](https://dash.cloudflare.com/login).
45+
1. Go to **Notifications**.
46+
1. Click **Destinations** on the left side of your dashboard.
47+
1. In the **Webhooks** card, click **Create**.
48+
1. Give your webhook a name so you can identify it later.
49+
1. In the **URL** field, enter the URL of the third-party service you set up above and want to connect to your Cloudflare account.
50+
1. If needed, insert the **Secret**. Secrets are how webhooks are encrypted and vary according to the service you are connecting to Cloudflare.
51+
52+
![Webhooks secret](../../static/images/notifications/webhooks.png)
53+
54+
1. Click **Save and Test** to finish setting up your webhook.
55+
56+
The new webhook will appear in the **Webhooks** card.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
order: 1
3+
title: Edit Notifications and webhooks
4+
pcx-content: how-to
5+
---
6+
7+
# Edit a Notification
8+
9+
1. Sign in to your [Cloudflare dashboard](https://dash.cloudflare.com/login).
10+
1. Click **Notifications** on the upper right corner.
11+
1. Click **Edit** on the Notification you want to modify.
12+
1. Make changes as needed and click **Save**.
13+
14+
This will take you back to your list of Notifications.
15+
16+
<Aside type="note" header="Note">
17+
18+
You can also disable and/or delete Notifications. To disable a notification, click the **Enabled** toggle. To delete it, click **Delete**.
19+
20+
</Aside>
21+
22+
## Edit a PagerDuty connected service
23+
24+
You can only disconnect PagerDuty services.
25+
26+
1. Sign in to your [Cloudflare dashboard](https://dash.cloudflare.com/login).
27+
1. Go to **Notifications**.
28+
1. Click **Destinations** on the left side of your dashboard.
29+
1. In the **Connected notification services** card, click **View** on the PagerDuty service you want to disconnect.
30+
1. Click **Disconnect**.
31+
1. Select **Confirm**.
32+
33+
## Edit webhooks
34+
35+
You can only edit the name of webhooks and/or delete them.
36+
37+
1. Sign in to your [Cloudflare dashboard](https://dash.cloudflare.com/login).
38+
1. Go to **Notifications**.
39+
1. Click **Destinations** on the left side of your dashboard.
40+
1. In the **Webhooks** card, click **Edit** on the webhook you want to edit.
41+
1. Change the webhook name as you see fit and click **Save**.
42+
43+
<Aside type="note" header="Note">
44+
45+
You can also delete a webhook after clicking **Edit**. However, it is faster to click **Delete** in the list of webhooks displayed in the **Destinations** card.
46+
47+
</Aside>
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
order: 6
3+
pcx-content: navigation
4+
---
5+
6+
# Configuring and creating notifications
7+
8+
Select one of the following tasks to get started:
9+
10+
<DirectoryListing path="/notifications/configure-create"/>
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
order: 4
3+
type: overview
4+
pcx-content: landing-page
5+
---
6+
7+
<ContentColumn>
8+
9+
# Cloudflare Notifications
10+
11+
Cloudflare Notifications help you stay up to date with your Cloudflare account. Manage your Notifications to define what you want to be warned about and how, be it a denial-of-service attack or an issue with your server.
12+
13+
The available Notification features vary according to your plan:
14+
* Free plans can set up email-based Notifications.
15+
* Professional and higher plans can also access PagerDuty.
16+
* Business and higher plans can also use webhooks.
17+
18+
## Where to find the Notifications section
19+
20+
Notifications are available in your [Cloudflare dashboard](https://dash.cloudflare.com/login). After logging in to your account, click **Notifications** on the top right of the menu in your account home page. Here you can create notifications for different scenarios, edit notifications previously set up, and enable or disable notifications.
21+
22+
![Where to find the Notifications section](../static/images/notifications/where-to-find.png)
23+
24+
Other features vary according to your plan:
25+
* Professional and higher plans can also connect a **PagerDuty** instance to send notifications to.
26+
* Business and higher plans also have access to **Webhooks**, to connect their Cloudflare account to external services such as Google Chat and Slack.
27+
28+
## What to do when receiving Notifications
29+
30+
Go to our [Types of Notifications](notification-available/) section to know more about what each Notification does and what do to when receiving one.
31+
32+
</ContentColumn>

0 commit comments

Comments
 (0)