使用 Webhook¶
在使用 LangGraph 平台时,你可能希望使用 Webhook 在 API 调用完成后接收更新。Webhook 对于在运行处理完成后触发你的服务中的操作非常有用。要实现这一点,你需要公开一个可以接受 POST
请求的端点,并将此端点作为 webhook
参数传递到你的 API 请求中。
目前,SDK 不提供内置支持来定义 Webhook 端点,但你可以通过 API 请求手动指定它们。
支持的端点¶
以下 API 端点接受 webhook
参数
操作 | HTTP 方法 | 端点 |
---|---|---|
创建运行 | POST |
/thread/{thread_id}/runs |
创建线程定时任务 | POST |
/thread/{thread_id}/runs/crons |
流式运行 | POST |
/thread/{thread_id}/runs/stream |
等待运行 | POST |
/thread/{thread_id}/runs/wait |
创建定时任务 | POST |
/runs/crons |
流式运行无状态 | POST |
/runs/stream |
等待运行无状态 | POST |
/runs/wait |
在本指南中,我们将展示如何在流式传输运行后触发 Webhook。
设置你的助手和线程¶
在进行 API 调用之前,请设置你的助手和线程。
curl --request POST \
--url <DEPLOYMENT_URL>/assistants/search \
--header 'Content-Type: application/json' \
--data '{ "limit": 10, "offset": 0 }' | jq -c 'map(select(.config == null or .config == {})) | .[0]' && \
curl --request POST \
--url <DEPLOYMENT_URL>/threads \
--header 'Content-Type: application/json' \
--data '{}'
响应示例
{
"thread_id": "9dde5490-2b67-47c8-aa14-4bfec88af217",
"created_at": "2024-08-30T23:07:38.242730+00:00",
"updated_at": "2024-08-30T23:07:38.242730+00:00",
"metadata": {},
"status": "idle",
"config": {},
"values": null
}
将 Webhook 与图运行结合使用¶
要使用 Webhook,请在你的 API 请求中指定 webhook
参数。当运行完成时,LangGraph 平台会向指定的 Webhook URL 发送一个 POST
请求。
例如,如果你的服务器在 https://my-server.app/my-webhook-endpoint
监听 Webhook 事件,请将其包含在你的请求中
Webhook 负载¶
LangGraph 平台以 运行 (Run) 的格式发送 Webhook 通知。有关详细信息,请参阅 API 参考。请求负载在 kwargs
字段中包含运行输入、配置和其他元数据。
安全 Webhook¶
为了确保只有经过授权的请求才能访问你的 Webhook 端点,请考虑添加安全令牌作为查询参数
你的服务器应在处理请求之前提取并验证此令牌。
测试 Webhook¶
你可以使用以下在线服务测试你的 Webhook
- Beeceptor – 快速创建测试端点并检查传入的 Webhook 负载。
- Webhook.site – 实时查看、调试和记录传入的 Webhook 请求。
这些工具可帮助你验证 LangGraph 平台是否正确触发并将 Webhook 发送到你的服务。