> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 触发自动化 webhook

> 为一个具有 webhook 触发器的自定义自动化排队一次运行，而不必等待该触发器配置的事件。适用于从 CI/CD 流水线、发布脚本或任何其他已经发送事件的系统运行自动化。只能触发配置了 webhook 触发器的自定义自动化；使用其他触发器的自动化会返回 `404` 响应。

请使用具有写入访问权限的组织 API 密钥进行身份验证。

使用此端点运行一个配置为 **Webhook** 触发器的自定义自动化。每次请求会将一次运行加入队列，该运行使用自动化保存的 prompt 并读取仓库的完整历史记录。请求体会被忽略。

此端点仅支持配置了 webhook 触发器的[自定义自动化](/docs/zh/automations/create)。预定义自动化以及使用其他任何触发器的自动化都会返回 `404` 响应。若要按需触发一个计划型自定义自动化，请改用[触发自动化](/docs/zh/api/automations/trigger)。

<div id="use-cases">
  ## 用例
</div>

* **CI/CD 流水线**：在每次合并到 `main` 或发布之后运行自定义自动化，无需等待计划运行。
* **发布事件**：在打出标签或发布新 SDK 版本时，从发布脚本运行自定义自动化。
* **内部工具**：从内部仪表板、Slack 命令或已有的计划任务中触发自动化。

<div id="get-the-webhook-url-and-auth-header">
  ## 获取 webhook URL 和身份验证请求头
</div>

在控制台中打开[自动化](https://app.mintlify.com/products/automations)页面，点击具有 webhook 触发器的自定义自动化上的 <Icon icon="settings-2" /> 设置按钮。触发器卡片会显示完整的 webhook URL，以及用于 `Authorization: Bearer <api-key>` 请求头模板的 **Copy auth header** 操作。

将 `<api-key>` 替换为具有写入权限且未过期的组织 API 密钥。在 [API keys](https://app.mintlify.com/settings/organization/api-keys) 页面创建或管理密钥。自动化不会为你创建、存储或轮换密钥。

<div id="example">
  ## 示例
</div>

每当代码合并到 `main` 时，从 GitHub Action 触发一个 webhook 自动化：

```yaml .github/workflows/trigger-docs.yml theme={null}
on:
  push:
    branches: [main]

jobs:
  trigger:
    runs-on: ubuntu-latest
    steps:
      - run: |
          curl -fsS -X POST \
            "https://api.mintlify.com/v2/workflow/$PROJECT_ID/$WORKFLOW_ID/webhook" \
            -H "Authorization: Bearer ${{ secrets.MINTLIFY_API_KEY }}"
        env:
          PROJECT_ID: ${{ vars.MINTLIFY_PROJECT_ID }}
          WORKFLOW_ID: ${{ vars.MINTLIFY_WORKFLOW_ID }}
```

<div id="rate-limits">
  ## 速率限制
</div>

此端点与[触发更新](/docs/zh/api/update/trigger)和[触发自动化](/docs/zh/api/automations/trigger)共享速率限制：每个组织每 10 秒最多 10 次请求。每次入队运行消耗的额度与其他任何自定义自动化运行相同。请参见[额度定价](/docs/zh/credits)。


## OpenAPI

````yaml zh/admin-openapi.json POST /v2/workflow/{projectId}/{workflowSchemaId}/webhook
openapi: 3.0.1
info:
  title: Mintlify Admin API
  description: 用于管理操作的 API，包括文档更新和代理管理。
  version: 2.0.0
servers:
  - url: https://api.mintlify.com
security:
  - bearerAuth: []
paths:
  /v2/workflow/{projectId}/{workflowSchemaId}/webhook:
    post:
      summary: 触发自动化 webhook
      description: >-
        为一个具有 webhook 触发器的自定义自动化排队一次运行，而不必等待该触发器配置的事件。适用于从 CI/CD
        流水线、发布脚本或任何其他已经发送事件的系统运行自动化。只能触发配置了 webhook 触发器的自定义自动化；使用其他触发器的自动化会返回
        `404` 响应。


        请使用具有写入访问权限的组织 API 密钥进行身份验证。
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: >-
            你的项目 ID。可以从控制台的 [API
            keys](https://app.mintlify.com/settings/organization/api-keys) 页面复制。
        - name: workflowSchemaId
          in: path
          required: true
          schema:
            type: string
          description: >-
            要触发的自动化的
            ID。可以从控制台[自动化](https://app.mintlify.com/products/automations)页面上该自动化的设置面板复制。
      responses:
        '202':
          description: 自动化运行已成功加入队列。
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  runId:
                    type: string
                    description: >-
                      已排队的自动化运行的
                      ID。会出现在[自动化](https://app.mintlify.com/products/automations)页面的运行历史中。
        '400':
          description: 自动化 ID 格式无效。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: 本计费周期的 AI 额度已耗尽。请升级你的套餐或等待额度续期。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 未找到该自动化，或该自动化未处于活动状态、不属于此项目，或未配置 webhook 触发器。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: 额度检查失败。请重试该请求。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 错误消息。
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的
        [API
        密钥页面](https://dashboard.mintlify.com/settings/organization/api-keys)
        中生成一个。

````

## Related topics

- [自动化概览](/docs/zh/automations/index.md)
- [管理自动化](/docs/zh/automations/manage.md)
- [触发自动化](/docs/zh/api/automations/trigger.md)