---
orphan: true
---
# 创建回调规则

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

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

```text
POST https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/callback-rules
```

## 调用前准备

准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/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"
  }'
```

:::::
:::::{tab-item} 参数说明

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `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。 |

:::::
::::::
:::::::

## 成功响应

成功时返回 `201` 和新建规则。

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{"code":0,"data":{"id":"rule_01"}}
```

:::::
:::::{tab-item} 字段说明

::::{tab-set}

:::{tab-item} 基础信息

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.id` | string | 新建回调规则 ID。 |

:::

:::{tab-item} 时间、版本与分页

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.version` | integer | 新建规则的版本；更新时填入请求体的 version。 |

:::

::::

:::::
::::::
:::::::

## 错误响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

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

:::::
:::::{tab-item} 字段说明

::::{tab-set}
:::{tab-item} 通用字段

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

:::
::::

:::::
::::::
:::::::