Webhook

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

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

用例

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

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

事件

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

Webhook 负载示例

Read more about Webhook Events (File-based) and Webhook Events (String-based) on Crowdin Developer Portal.

添加 Webhooks

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

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

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

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

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

添加 Webhook

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

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

编辑或删除 Webhook

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

管理 Webhooks

调用历史

调用历史 部分中,您可以看到项目中配置的所有网络钩子的调用列表。 使用过滤器查看所有或仅显示不成功的 webhook 通知。

调用历史

Failing Webhooks

Webhooks that fail 100 or more times in the last 24 hours with response codes in the 4xx or 5xx ranges are automatically disabled.

Disabled Webhooks

Disabled webhooks are listed in the Webhooks section with a cleared check mark, indicating that they are currently inactive due to persistent failures. To discover more about failed webhooks, navigate to the Calls History > Unsuccessful section. Here you can explore detailed information about the issues encountered by each failed webhook.

Manual Re-enabling

Once you have identified and resolved the cause of the webhook failures, you can manually re-enable the webhooks to restore their functionality. In the Webhooks section, locate the disabled webhook and select it for re-enabling.

寻求协助

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

本文是否有帮助?