mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
dbaedf2ae7
* docs: document trigger automation API endpoint * docs: translate trigger automation API docs to es, fr, zh * Fix rate limit for trigger automation endpoint The docs incorrectly borrowed the 5-requests-per-minute limit from Trigger preview deployment. The endpoint actually shares Trigger update's limiter: 10 requests per 10 seconds per organization. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
46 lines
2.0 KiB
Plaintext
46 lines
2.0 KiB
Plaintext
---
|
|
title: "Trigger automation"
|
|
openapi: "/openapi.json POST /workflow/{projectId}/{workflowSchemaId}/trigger"
|
|
keywords: ["automation", "workflow", "trigger", "webhook", "schedule", "CI"]
|
|
---
|
|
|
|
Use this endpoint to trigger a scheduled automation on demand, instead of waiting for its next scheduled run. The automation behaves identically to a regular scheduled run: it picks up everything that has changed since the last completed run.
|
|
|
|
This endpoint only supports automations configured with a **Custom schedule** trigger. Requests for automations with other triggers, like **Code change** or **Content update**, return a `400` error.
|
|
|
|
## Use cases
|
|
|
|
- **CI/CD pipelines**: Run the **Update from code changes** automation on every merge to `main`, so docs update at your release cadence rather than on a fixed schedule.
|
|
- **Release events**: Run the **Draft changelog** automation when you cut a release tag, so the changelog drafts at the same time the release ships.
|
|
- **Custom tooling**: Trigger automations from internal tools, Slack commands, or scheduled jobs you already run.
|
|
|
|
## Find the automation ID
|
|
|
|
Copy the automation ID from the automation's settings panel on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
|
|
|
|
## Example
|
|
|
|
Trigger an automation from a GitHub Action whenever code merges to `main`:
|
|
|
|
```yaml .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/v1/workflow/$PROJECT_ID/$WORKFLOW_ID/trigger" \
|
|
-H "Authorization: Bearer ${{ secrets.MINTLIFY_API_KEY }}"
|
|
env:
|
|
PROJECT_ID: ${{ vars.MINTLIFY_PROJECT_ID }}
|
|
WORKFLOW_ID: ${{ vars.MINTLIFY_WORKFLOW_ID }}
|
|
```
|
|
|
|
## Rate limits
|
|
|
|
This endpoint shares a rate limit with [Trigger update](/api/update/trigger): up to 10 requests per 10 seconds per organization. Triggered runs consume credits at the same rate as scheduled runs.
|