使用 Webhooks¶

在使用 LangGraph Cloud 时，您可能希望使用 webhook 在 API 调用完成后接收更新。Webhook 对于在运行处理完毕后触发您的服务中的操作非常有用。要实现这一点，您需要暴露一个可以接受 POST 请求的端点，并在您的 API 请求中将此端点作为 webhook 参数传递。

目前，SDK 未提供内置支持来定义 webhook 端点，但您可以使用 API 请求手动指定它们。

支持的端点¶

以下 API 端点接受 webhook 参数

操作	HTTP 方法	端点
创建运行	`POST`	`/thread/{thread_id}/runs`
创建线程 Cron	`POST`	`/thread/{thread_id}/runs/crons`
流式传输运行	`POST`	`/thread/{thread_id}/runs/stream`
等待运行	`POST`	`/thread/{thread_id}/runs/wait`
创建 Cron	`POST`	`/runs/crons`
流式传输无状态运行	`POST`	`/runs/stream`
等待无状态运行	`POST`	`/runs/wait`

在本指南中，我们将展示如何在流式传输运行后触发 webhook。

设置您的助手和线程¶

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

Python

from langgraph_sdk import get_client

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

JavaScript

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

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 Cloud 会向指定的 webhook URL 发送 POST 请求。

例如，如果您的服务器在 https://my-server.app/my-webhook-endpoint 监听 webhook 事件，请在您的请求中包含此信息

Python

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

JavaScript

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) {
  // Handle stream output
}

CURL

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 Cloud 以 Run 的格式发送 webhook 通知。详情请参阅API 参考。请求负载在 kwargs 字段中包含运行输入、配置和其他元数据。

保护 Webhooks¶

为确保只有授权请求才能到达您的 webhook 端点，请考虑将安全令牌添加为查询参数

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

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

测试 Webhooks¶

您可以使用以下在线服务测试您的 webhook，例如

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

这些工具帮助您验证 LangGraph Cloud 是否正确触发并将 webhook 发送到您的服务。

遵循这些步骤，您可以将 webhook 集成到您的 LangGraph Cloud 工作流程中，根据完成的运行自动化操作。