使用 Webhook¶

在使用 LangGraph Platform 时，您可能希望接收 API 调用完成后的更新，这时就可以使用 Webhook。Webhook 可用于在某个运行（run）处理完成后触发您的服务中的操作。要实现此功能，您需要公开一个可以接受 POST 请求的端点，并将该端点作为 webhook 参数传递给您的 API 请求。

目前，SDK 不提供内置的 Webhook 端点定义支持，但您可以通过 API 请求手动指定它们。

支持的端点¶

以下 API 端点接受 webhook 参数：

在本指南中，我们将演示如何在使用流式传输 run 时触发 Webhook。

设置您的助手和线程¶

在进行 API 调用之前，请先设置您的助手和线程。

from langgraph_sdk import get_client

client = get_client(url=<DEPLOYMENT_URL>)
assistant_id = "agent"
thread = await client.threads.create()
print(thread)

import { Client } from "@langchain/langgraph-sdk";

const client = new Client({ apiUrl: <DEPLOYMENT_URL> });
const assistantID = "agent";
const thread = await client.threads.create();
console.log(thread);

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 与 Graph 运行结合使用¶

要使用 Webhook，请在您的 API 请求中指定 webhook 参数。当运行完成后，LangGraph Platform 会向指定的 Webhook URL 发送一个 POST 请求。

例如，如果您的服务器监听的 Webhook 事件端点是 https://my-server.app/my-webhook-endpoint，请在请求中包含此项：

input = { "messages": [{ "role": "user", "content": "Hello!" }] }

async for chunk in client.runs.stream(
    thread_id=thread["thread_id"],
    assistant_id=assistant_id,
    input=input,
    stream_mode="events",
    webhook="https://my-server.app/my-webhook-endpoint"
):
    pass

const input = { messages: [{ role: "human", content: "Hello!" }] };

const streamResponse = client.runs.stream(
  thread["thread_id"],
  assistantID,
  {
    input: input,
    webhook: "https://my-server.app/my-webhook-endpoint"
  }
);

for await (const chunk of streamResponse) {
  // 处理流输出
}

curl --request POST \
    --url <DEPLOYMENT_URL>/threads/<THREAD_ID>/runs/stream \
    --header 'Content-Type: application/json' \
    --data '{
        "assistant_id": <ASSISTANT_ID>,
        "input": {"messages": [{"role": "user", "content": "Hello!"}]},
        "webhook": "https://my-server.app/my-webhook-endpoint"
    }'

Webhook 负载¶

LangGraph Platform 以 Run 的格式发送 Webhook 通知。有关详细信息，请参阅 API 参考。请求负载在 kwargs 字段中包含运行输入、配置和其他元数据。

安全地使用 Webhook¶

为确保只有授权请求才能命中您的 Webhook 端点，请考虑添加一个安全令牌作为查询参数：

https://my-server.app/my-webhook-endpoint?token=YOUR_SECRET_TOKEN

您的服务器应在处理请求之前提取并验证此令牌。

测试 Webhook¶

您可以使用在线服务测试您的 Webhook，例如：

• Beeceptor – 快速创建测试端点并检查传入的 Webhook 负载。
• Webhook.site – 实时查看、调试和记录传入的 Webhook 请求。

这些工具可帮助您验证 LangGraph Platform 是否正确触发并向您的服务发送 Webhook。