创建回调规则

创建将提供商回调事件路由到工作区资源的规则。

POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/callback-rules

调用前准备

准备可访问目标工作区的个人访问令牌和目标工作区 ID。

确认当前身份有权使用目标自动化任务关联的智能体。

请求体

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/callback-rules" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "provider": "github",
    "credential_ref": "credential_01",
    "name": "Issue 回调",
    "target_type": "agent_automation_task",
    "target_config": {
      "automation_task_id": "'"$AUTOMATION_TASK_ID"'"
    }
  }'

参数说明

服务端根据调用身份保存执行主体和有效角色，不能在请求体中指定其他身份。 读取、列表和删除不只检查创建者身份。

字段	类型	是否必填	说明
provider	string	是	回调提供商标识。
credential_ref	string	是	提供商凭据引用。
name	string	是	回调规则名称。
target_type	string	是	回调目标类型。当前仅支持 agent_automation_task。
description	string	否	回调规则说明。
enabled	boolean	否	是否启用规则。
priority	integer	否	匹配优先级。
match	object	否	匹配条件，可包含 resource_kinds、event_types、event_actions 和 field_equals。
target_config	object	是	回调目标配置。当前必须包含 automation_task_id。
stop_after_match	boolean	否	命中此规则后是否停止继续匹配。
target_config.automation_task_id	string	是	接收回调的自动化任务 ID。任务必须处于启用状态，且 trigger.mode 为 callback。
match.resource_kinds	string（字符串数组）	否	匹配的资源种类。
match.event_types	string（字符串数组）	否	匹配的事件类型。
match.event_actions	string（字符串数组）	否	匹配的事件动作。
match.field_equals	object	否	字段路径到字符串匹配值的映射。

目标自动化任务必须属于当前工作区，处于启用状态，并采用回调触发方式。target_config.automation_task_id 填写该任务的 ID。

每类数组内任一项命中即可，但不同类别和 field_equals 中的所有字段都必须满足。空数组不限制该类别。值须为规范的单行字符串，field_equals 允许空字符串值，字段路径用点分隔。

成功响应

响应示例

{
  "code": 0,
  "data": {
    "id": "rule_01",
    "workspace_id": "workspace_example",
    "provider": "wecom",
    "credential_ref": "cred_01",
    "name": "告警回调",
    "enabled": true,
    "priority": 0,
    "match": {
      "event_types": [
        "message"
      ]
    },
    "target_type": "agent_automation_task",
    "stop_after_match": false,
    "version": 1,
    "created_at": "2026-10-14T00:00:00Z",
    "updated_at": "2026-10-14T00:00:00Z",
    "target_config": {
      "automation_task_id": "task_01",
      "user_api_key_configured": true
    }
  }
}

字段说明

字段	类型	说明
code	integer	请求处理成功时为 0。
data	object	响应数据。
data.id	string	新建回调规则 ID。
data.workspace_id	string	所属工作区 ID。
data.provider	string	提供商标识。
data.credential_ref	string	已保存凭据的引用，不是明文密钥。
data.name	string	名称。
data.description	string	说明。未设置时可省略。
data.enabled	boolean	是否启用。
data.priority	integer	匹配优先级。
data.match	object	匹配条件。
data.match.resource_kinds	string（字符串数组）	匹配的资源种类。数组内任一项可命中。未设置时可省略。
data.match.event_types	string（字符串数组）	匹配的事件类型。数组内任一项可命中。未设置时可省略。
data.match.event_actions	string（字符串数组）	匹配的事件动作。数组内任一项可命中。未设置时可省略。
data.match.field_equals	object	字段路径与匹配值的键值对。未设置时可省略。
data.target_type	string	回调目标类型，当前为 agent_automation_task。
data.target_config	object	回调目标配置及公开扩展字段。未设置时可省略。
data.target_config.automation_task_id	string	接收回调的自动化任务 ID。
data.target_config.user_api_key_configured	boolean	是否已保存用于目标调用的凭据。未设置时可省略。
data.stop_after_match	boolean	是否在命中后停止继续匹配。
data.version	integer	新建规则的版本。更新时填入请求体的 version。
data.created_by	string	创建者标识。未设置时可省略。
data.updated_by	string	最近更新者标识。未设置时可省略。
data.created_at	string	创建时间，采用 RFC 3339 格式。
data.updated_at	string	最近更新时间，采用 RFC 3339 格式。

错误响应

响应示例

{
  "code": 2,
  "message": "invalid callback rule"
}

字段说明

字段	类型	说明
code	integer	错误代码。
message	string	面向调用者的错误信息。

最后更新于 2026 年 10 月 19 日