​
概述

企业版事件流式传输允许您接收部署到 CrewAI Enterprise 的 crew 和 flow 的实时 webhook 更新，例如模型调用、工具使用和 flow 步骤。

​
用法

使用 Kickoff API 时，在您的请求中包含一个 webhooks 对象，例如

{
  "inputs": {"foo": "bar"},
  "webhooks": {
    "events": ["crew_kickoff_started", "llm_call_started"],
    "url": "https://your.endpoint/webhook",
    "realtime": false,
    "authentication": {
      "strategy": "bearer",
      "token": "my-secret-token"
    }
  }
}

如果将 realtime 设置为 true，每个事件将单独且立即发送，但这会牺牲 crew/flow 的性能。

​
Webhook 格式

每个 webhook 发送一个事件列表

{
  "events": [
    {
      "id": "event-id",
      "execution_id": "crew-run-id",
      "timestamp": "2025-02-16T10:58:44.965Z",
      "type": "llm_call_started",
      "data": {
        "model": "gpt-4",
        "messages": [
          {"role": "system", "content": "You are an assistant."},
          {"role": "user", "content": "Summarize this article."}
        ]
      }
    }
  ]
}

data 对象的结构因事件类型而异。请参阅 GitHub 上的事件列表。

由于请求通过 HTTP 发送，事件的顺序无法保证。如果您需要顺序，请使用 timestamp 字段。

​
支持的事件

CrewAI 在企业版事件流式传输中同时支持系统事件和自定义事件。这些事件会在 crew 和 flow 执行期间发送到您配置的 webhook 端点。

  • crew_kickoff_started
  • crew_step_started
  • crew_step_completed
  • crew_execution_completed
  • llm_call_started
  • llm_call_completed
  • tool_usage_started
  • tool_usage_completed
  • crew_test_failed
  • ...及其他

事件名称与内部事件总线一致。请参阅GitHub 源代码以获取完整列表。

您可以发出自己的自定义事件，它们将与系统事件一起通过 webhook 流式传输。

需要帮助？

请联系我们的支持团队，获取有关 webhook 集成或故障排除的帮助。