跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

配置 Webhook

最后更新 查看 MarkdownAgent 设置

Webhook 可将 Cloudflare 告警投递到任何接受 HTTP 回调的服务。你可以连接到 Slack、Google Chat 和 PagerDuty 等常见服务,或为任意自定义端点配置通用 Webhook。

创建 Webhook

  1. 在 Cloudflare 仪表板中,前往 Alerts > Destinations。

    前往 Alerts ↗
  2. 在 Webhooks 卡片中,选择 Create。

  3. 为 Webhook 命名。

  4. 在 URL 字段中,输入要连接的服务的 Webhook URL。

  5. 如有需要,请输入 Secret。密钥因服务而异 — 详情请参阅常见 Webhook 服务。

  6. 选择 Save and Test 以完成 Webhook 的设置。

编辑或删除 Webhook

你可以重命名或删除现有 Webhook。

  1. 在 Cloudflare 仪表板中,前往 Alerts > Destinations。

    前往 Alerts ↗
  2. 在 Webhooks 卡片中,选择要修改的 Webhook 上的 Edit。

  3. 更新名称并选择 Save,或选择 Delete 将其移除。

防火墙设置

Webhook 告警从 Cloudflare 的 IP 范围 ↗发送。如果您的 Webhook 端点受防火墙保护,则必须将这些 IP 地址加入允许列表才能接收告警。

要以编程方式检索当前 Cloudflare IP 地址列表,请使用 Cloudflare API。

通用 Webhook

如果您使用的服务不在 Cloudflare 当前支持的 Webhook 服务列表中,您可以自行配置,并输入有效的 Webhook URL。

建议始终为通用 Webhook 使用密钥。Cloudflare 将在每次请求的 cf-webhook-auth 标头中发送您的密钥。如果此标头不存在或其值与您指定的值不符,您应拒绝该 Webhook。

当 Cloudflare 发送 Webhook 告警时,载荷结构如下:

Example schemajson
{
	"text": "Hello World! This is a test message sent from https://cloudflare.com. If you can see this, your webhook is configured properly."
}

有关完整载荷结构和示例,请参阅 Webhook 载荷结构参考。

通用 Webhook 的限制

通用 Webhook 告警仅会分发到端口 80 或 443 上可公开解析的 IP 地址。

如果您希望在私有 IP 地址或不同端口上接收告警,可以使用 Workers 接收并转发告警,或设置 Cloudflare Tunnel 路由到您的已连接应用程序。

将通用 Webhook 与 Workers 结合使用

您可以将 Cloudflare Workers 与通用 Webhook 结合使用,将告警投递到任何接受 Webhook 的服务。

Cloudflare 提供了一个示例工具 ↗,演示如何使用 Workers 转换通用 Webhook 载荷以便投递到 Rocket.Chat。代码中包含大量注释,帮助您将其适配到自身需求。

Google Chat

对于 Google Chat ↗:

  • 密钥:密钥是 URL 的一部分。Cloudflare 会自动解析此信息,无需用户输入。
  • URL:URL 因 Google Chat 频道的地址而异。

Slack

对于 Slack ↗:

  • 密钥:密钥是 URL 的一部分。Cloudflare 会自动解析此信息,无需用户输入。
  • URL:URL 因 Slack 频道的地址而异。

DataDog

对于 DataDog ↗:

  • 密钥:必须由用户输入密钥。这是 DataDog 所称的 API Key ↗。
  • URL:https://api.datadoghq.com/api/v1/events

Discord

对于 Discord ↗:

  • 密钥:密钥是 URL 的一部分。Cloudflare 会自动解析此信息,无需用户输入。
  • URL:URL 因 Discord 频道的地址而异。

OpsGenie

对于 OpsGenie ↗:

  • 密钥:密钥是 OpsGenie REST API 的 API Key。
  • URL:https://api.opsgenie.com/v2/alerts

Splunk

对于 Splunk ↗:

  • 密钥:必须由用户输入密钥。这是 Splunk 所称的 token。详情请参阅 Splunk 文档 ↗。
  • URL:
    1. 我们仅支持三个 Splunk 端点:services/collector、services/collector/raw 和 services/collector/event。
    2. 如果令牌启用了 SSL,端口必须为 443。如果令牌未启用 SSL,端口必须为 8088。
    3. 服务器必须启用 SSL。
    4. Splunk HTTP 事件收集器上必须禁用启用索引器确认。

Feishu

对于飞书 (Feishu) ↗:

  • 密钥:密钥是 URL 的一部分。Cloudflare 会自动解析此信息,无需用户输入。
  • URL:URL 因自定义机器人而异。

Teams

对于 Teams ↗:

  • 密钥:密钥是 URL 的一部分。Cloudflare 会自动解析此信息,无需用户输入。
  • URL:URL 由 Teams 在创建传入 Webhook 连接器时提供。

ServiceNow

对于 ServiceNow ↗:

  • 密钥:由用户决定。请确保在 Cloudflare 中输入的密钥与 ServiceNow 中配置的一致。详情请参阅 ServiceNow 文档 ↗。
  • URL:https://{servicenow_instance}.com/{base_api_path}

通用 Webhook

对于通用 Webhook:

  • 密钥:由用户决定。
  • URL:由用户决定。

密钥配置

对于 Google Chat、Slack、Discord 和飞书 Webhook,密钥嵌入在 URL 中并会自动提取。你也可以从 URL 中移除密钥并显式设置,这在使用 Terraform 将 Webhook 作为基础设施即代码管理时很有用。

Terraform exampletf
resource "cloudflare_notification_policy_webhooks" "example" {
  account_id = "<ACCOUNT_ID>"
  name       = "Slack Webhook"
  url        = "https://hooks.slack.com/services/T00000000/B00000000"
  secret     = "<secret>"
}

这篇文档对您有帮助吗?