Webhook 网络钩子节点#
使用 Webhook 网络钩子节点创建 webhooks，它可以在事件发生时接收来自应用程序和服务的数据。它是一个触发器节点，这意味着它可以启动 n8n 工作流。这允许服务连接到 n8n 并运行工作流。
当您想要接收数据并基于数据运行工作流时，可以使用 Webhook 网络钩子节点作为工作流的触发器。Webhook 网络钩子节点还支持返回在工作流结束时生成的数据。这使得它对于构建处理数据并返回结果的工作流很有用，就像 API 端点一样。
网络钩子允许您从没有专用应用程序触发器节点的服务触发工作流。
Workflow development process 工作流开发过程#
n8n 为测试和生产提供不同的 Webhook URL。测试 URL 包含 Listen for test event 监听测试事件 选项。请参考 Workflow development 工作流开发 了解有关构建、测试和将 Webhook 网络钩子节点转移到生产环境的更多信息。
Node parameters 节点参数#
使用这些参数来配置您的节点。
Webhook URLs 网络钩子URL#
Webhook 网络钩子节点有两个 Webhook URLs 网络钩子URL：测试和生产。n8n 在节点面板顶部显示 URL。
选择 Test URL 测试URL 或 Production URL 生产URL 来切换 n8n 显示的 URL。
- Test 测试：当您选择 Listen for Test Event 监听测试事件 或 Execute workflow 执行工作流（如果工作流未激活）时，n8n 注册一个测试网络钩子。当您调用网络钩子 URL 时，n8n 在工作流中显示数据。
- Production 生产：当您激活工作流时，n8n 注册一个生产网络钩子。使用生产 URL 时，n8n 不会在工作流中显示数据。您仍然可以查看生产执行的工作流数据：在工作流中选择 Executions 执行 选项卡，然后选择您要查看的工作流执行。
HTTP Method HTTP方法#
Webhook 网络钩子节点支持标准的 HTTP Request Methods：
- DELETE 删除
- GET 获取
- HEAD
- PATCH 修补
- POST 发送
-
PUT 推送
Webhook max payload 网络钩子最大负载
网络钩子最大负载大小为 16MB。 如果您自托管 n8n，您可以使用 endpoint environment variable 端点环境变量
N8N_PAYLOAD_SIZE_MAX来更改此设置。
Path 路径#
默认情况下，此字段包含随机生成的网络钩子 URL 路径，以避免与其他网络钩子节点冲突。
您可以手动指定 URL 路径，包括添加路由参数。例如，如果您使用 n8n 原型化 API 并希望一致的端点 URL，则可能需要这样做。
Path 路径 字段可以采用以下格式：
/:variable/path/:variable/:variable/path/:variable1/path/:variable2/:variable1/:variable2
Supported authentication methods 支持的身份验证方法#
您可以为调用网络钩子 URL 的任何服务要求身份验证。从这些身份验证方法中选择：
- Basic auth 基本认证
- Header auth 头部认证
- JWT auth JWT认证
- None 无
请参考 Webhook credentials 网络钩子凭据 了解有关设置每种凭据类型的更多信息。
Respond 响应#
- Immediately 立即：Webhook 网络钩子节点返回响应代码和消息 Workflow got started 工作流已启动。
- When Last Node Finishes 当最后一个节点完成时：Webhook 网络钩子节点返回响应代码和工作流中执行的最后一个节点的数据输出。
- Using 'Respond to Webhook' Node 使用"响应网络钩子"节点：Webhook 网络钩子节点按照 Respond to Webhook 响应网络钩子 节点中定义的方式响应。
Response Code 响应代码#
自定义 Webhook 网络钩子节点在成功执行后返回的 HTTP response code HTTP响应代码。从常见响应代码中选择或创建自定义代码。
Response Data 响应数据#
选择要在响应正文中包含的数据：
- All Entries 所有条目：Webhook 网络钩子在数组中返回最后一个节点的所有条目。
- First Entry JSON 第一个条目JSON：Webhook 网络钩子在 JSON 对象中返回最后一个节点第一个条目的 JSON 数据。
- First Entry Binary 第一个条目二进制：Webhook 网络钩子在二进制文件中返回最后一个节点第一个条目的二进制数据。
- No Response Body 无响应正文：Webhook 网络钩子返回时不带正文。
仅适用于 Respond > When Last Node Finishes 响应 > 当最后一个节点完成时。
Node options 节点选项#
选择 Add Option 添加选项 查看更多配置选项。可用选项取决于您的节点参数。请参考表格了解选项的可用性。
- Allowed Origins (CORS) 允许的来源（CORS）：设置允许的跨域域。输入允许跨域非预检请求的逗号分隔的 URL 列表。使用
*（默认）允许所有来源。 - Binary Property 二进制属性：启用此设置允许 Webhook 网络钩子节点接收二进制数据，例如图像或音频文件。输入二进制属性的名称以将接收到的文件数据写入其中。
- Ignore Bots 忽略机器人：忽略来自机器人的请求，如链接预览器和网络爬虫。
- IP(s) Whitelist IP白名单：启用此功能以限制谁（或什么）可以调用 Webhook 触发器 URL。输入允许的 IP 地址的逗号分隔列表。来自白名单外 IP 地址的访问会抛出 403 错误。如果留空，所有 IP 地址都可以调用网络钩子触发器 URL。
- No Response Body 无响应正文：启用此功能以防止 n8n 发送带有响应的正文。
- Raw Body 原始正文：指定 Webhook 网络钩子节点将以原始格式接收数据，例如 JSON 或 XML。
- Response Content-Type 响应内容类型：选择网络钩子正文的格式。
- Response Data 响应数据：随响应发送自定义数据。
- Response Headers 响应头：在 Webhook 网络钩子响应中发送额外的头。请参考 MDN Web Docs | Response header 了解有关响应头的更多信息。
- Property Name 属性名称：默认情况下，n8n 返回所有可用数据。您可以选择返回特定的 JSON 键，以便 n8n 返回该值。
| Option 选项 | Required node configuration 所需的节点配置 |
|---|---|
| Allowed Origins (CORS) 允许的来源（CORS） | Any 任何 |
| Binary Property 二进制属性 | Either: HTTP Method > POST HTTP Method > PATCH HTTP Method > PUT |
| Ignore Bots 忽略机器人 | Any 任何 |
| IP(s) Whitelist IP白名单 | Any 任何 |
| Property Name 属性名称 | Both: Respond > When Last Node Finishes Response Data > First Entry JSON |
| No Response Body 无响应正文 | Respond > Immediately |
| Raw Body 原始正文 | Any 任何 |
| Response Code 响应代码 | Any except Respond > Using 'Respond to Webhook' Node |
| Response Content-Type 响应内容类型 | Both: Respond > When Last Node Finishes Response Data > First Entry JSON |
| Response Data 响应数据 | Respond > Immediately |
| Response Headers 响应头 | Any 任何 |
模板和示例#
常见问题#
对于常见问题或故障和建议的解决方案，请参考 常见问题。