Webhook

Webhook 通知并帮助您收集在 Crowdin 企业版上发生的关键事件的信息，例如译文完成或校对。配置 Webhook 后，Crowdin 企业版将开始通过 HTTP 向 Webhook URL 发送带有数据的 POST 或 GET 请求。

用例

您可以通过添加 webhooks 来建立与服务或与您后端的集成。例如：

您可以为项目中发生的不同事件配置 webhook，例如，当文件被翻译、校对，或字符串被添加或更新时。

在 Crowdin 开发者门户上阅读更多关于 Webhook 事件的信息。

要在 Crowdin 企业版中配置 Webhook，请按照以下步骤操作：

您需要提供以下信息才能注册 Webhook：

Webhook 名称（例如，“New translation added”）。
要发布到指定 URL 的事件列表。您可以选择任意一个或一组事件。
作为直接请求发送 webhook 回调的目标 URL。不支持重定向，重定向将导致传送失败。端点必须在 30 秒内返回 2XX 响应。
对某资源需要执行的请求方法（GET或POST）。
POST 请求方法的内容类型（multipart/form-data、application/json 或 application/x-www-form-urlencoded）。
- 对于 application/json 内容类型，您可以选择 批量 webhook 将多个事件合并为单个请求。

您可以选择为您的 webhook 添加特殊标头。作为一种授权方法，它们可以用来提供更多的安全保障。例如，如果添加标头，则 Webhook 终结点可以检查它们，以确保信息来自 Crowdin 企业版。

取决于您的 Webhook 管理方式，您可能需要将专用的 Crowdin 企业版 IP 地址添加到防火墙，以允许 Crowdin 企业版打开预配置的 Webhook URL。

详细了解 IP 地址。

Crowdin 企业版中的每种事件类型都有特定的有效负载格式，包含相关事件信息。您可以自定义 webhook 载荷，按照系统要求的方式添加和组织元素。

要查看事件的可用变量，请将鼠标悬停在有效负载部分右上角的信息图标上。

您可以访问特定项目中所有现有的 web 钩子的列表。您能够从显示的 Web 钩子列表中编辑或删除任何 Web 钩子。

事件触发后，您将能够分别查看每个 Webhook 的活动。使用筛选器查看所有或仅显示失败的 Webhook 通知。

或者，您可以在工具 > Webhooks 日志中查看已发送 Webhook 的完整列表。按结果（任意或失败）、事件类型或名称筛选 Webhook 通知。

过去 24 小时内响应代码为 4xx 或 5xx 范围内且失败次数达到 100 次及以上的 Webhook 会被自动禁用。

已禁用的 webhook 会在 Webhooks 部分列出，并显示一个清除的勾选标记，表示它们当前由于持续失败而处于非活动状态。要了解有关失败 webhook 的更多信息，请导航到 调用历史 > 失败 部分。在这里，您可以探索有关每个失败的 Webhook 所遇到的问题的详细信息。

一旦您识别并解决了 Webhook 失败的原因，就可以手动重新启用 Webhook 以恢复其功能。在 Webhooks 部分，找到已禁用的 webhook 并选择它进行重新启用。

借助 Crowdin 企业版 Webhook，您可以将预配置事件类型的通知直接发送到特定的 Slack 频道。

要配置向 Slack 发送 webhook，您需要创建一个简单的 Slack 应用。

创建并配置好 Slack 应用后，您将获得一个 Webhook URL，该 URL 应用于 Crowdin 企业版中的 Webhooks 配置。

本页面对你有帮助吗？