Webhook

通过 Webhook，您可以接收 Crowdin 项目中发生的关键事件的相关信息，例如译文已完成或校对。 当您针对项目配置 webhook 后，Crowdin 将开始通过 HTTP 发送带有数据的 POST 或 GET 请求。

只有项目拥有者和项目管理员才能注册 webhook。

用例

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

• 设置 webhook 来向您的系统发送通知。
• 向第三方服务传送附加有特定请求需求的信息（例如HTTP方法、内容类型等）。
• 创建与 Crowdin 的自定义集成。

事件

您可以为以下类型的事件配置 webhooks：

• 完全翻译好的文件（特定于基于文件的项目） – 文件被翻译成目标语言之一
• 文件完全审阅（特定于基于文件的项目） – 文件中的译文已针对目标语言之一得到批准
• 文件已添加（特定于基于文件的项目）
• 文件已更新（特定于基于文件的项目）
• 文件已还原（特定于基于文件的项目）
• 文件已删除（特定于基于文件的项目）
• Project fully translated – all files are translated into one of the target languages
• Project fully reviewed – translations in all files are approved for one of the target languages
• 项目成功构建（特定于基于文件的项目）
• Exported translation updated – final translation of a string is updated
• Source string added
• Source string updated
• Source string deleted
• Suggested translation added – a string in the project is translated
• Suggested translation updated – a translation for a string in the project is updated
• Suggested translation deleted – one of the translations is deleted
• Suggested translation approved – a translation for a string is approved
• Suggested translation disapproved – approval for a previously added translation is removed
• String comment/issue created
• String comment/issue updated
• String comment/issue deleted
• String comment/issue restored
• Task added
• Task status changed
• Task deleted

Webhook 负载示例

在 Crowdin 开发者门户上阅读有关 基于文件的 Webhook 事件 和 基于字符串的 Webhook 事件 的更多信息。

添加 Webhooks

要在 Crowdin 中配置 webhook，打开您的项目，并前往 工具 > Webhooks。 点击 添加 Webhook 开始配置您的新 Webhook。

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

• Webhook 名称（例如“应用程序项目已翻译”）
• 要发布到指定 URL 的事件列表。 您可以选择任意一个或一组事件。
• 应发送回调的 URL 地址。
• 对某资源需要执行的请求方法（GET或POST）。
• POST 请求方法的内容类型 (multipart/form-data、application/json 或 application/x-www-form-urlencoded)。
• 对于 application/json 内容类型，您可以选择 批次网络钩子 将多个事件合并为单个请求。

Optionally, you can add special headers to your webhook. 作为一种授权方法，它们可以用来提供更多的安全保障。 例如，如果添加标头，则 Webhook 终结点可以检查它们，以确保信息来自 Crowdin。

添加 Webhook 时，点击测试 Webhook 以查看应用程序将如何响应该调用。

根据您的 Webhook 管理方法，您可能需要向防火墙添加专用的 Crowdin IP 地址，以允许 Crowdin 打开预配置的 Webhook URL。

阅读更多有关 IP 地址 的信息。

编辑或删除 Webhook

在特定项目中，您可以直接从显示的列表中编辑或删除已配置的 webhook，从而访问和管理它们。

调用历史

在 调用历史 部分中，您可以看到项目中配置的所有网络钩子的调用列表。 使用过滤器查看所有或仅显示失败的 Webhook 通知。

Webhook 失败

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

已禁用的 Webhook

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

手动重新启用

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

寻求协助

在 Webhook 使用上有任何问题或需要帮助？ 联系支持团队。