Skip to content
Mintlify
Mintlify
管理

触发自动化 webhook

POST/v2/workflow/{projectId}/{workflowSchemaId}/webhook

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

此端点仅支持配置了 webhook 触发器的自定义自动化。预定义自动化以及使用其他任何触发器的自动化都会返回 404 响应。若要按需触发一个计划型自定义自动化,请改用触发自动化

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

在控制台中打开自动化页面,点击具有 webhook 触发器的自定义自动化上的 设置按钮。触发器卡片会显示完整的 webhook URL,以及用于 Authorization: Bearer <api-key> 请求头模板的 Copy auth header 操作。

<api-key> 替换为具有写入权限且未过期的组织 API 密钥。在 API keys 页面创建或管理密钥。自动化不会为你创建、存储或轮换密钥。

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

.github/workflows/trigger-docs.yml
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 }}

此端点与触发更新触发自动化共享速率限制:每个组织每 10 秒最多 10 次请求。每次入队运行消耗的额度与其他任何自定义自动化运行相同。请参见额度定价

Was this page helpful?Suggest editsRaise issue