Skip to main content
POST
/
workflow
/
{projectId}
/
{workflowSchemaId}
/
trigger
Trigger automation
curl --request POST \
  --url https://api.mintlify.com/v1/workflow/{projectId}/{workflowSchemaId}/trigger \
  --header 'Authorization: Bearer <token>'
{
  "schemaId": "<string>",
  "instanceId": "<string>",
  "jobId": "<string>"
}
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 page in your dashboard.

​
Example

Trigger an automation from a GitHub Action whenever code merges to main:
.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: up to 5 requests per minute per organization. Triggered runs consume credits at the same rate as scheduled runs.

Authorizations

​
Authorization
string
header
required

The Authorization header expects a Bearer token. Use an admin API key (prefixed with mint_). This is a server-side secret key. Generate one on the API keys page in your dashboard.

Path Parameters

​
projectId
string
required

Your project ID. Can be copied from the API keys page in your dashboard.

​
workflowSchemaId
string
required

The ID of the automation to trigger. Can be copied from the automation's settings panel on the Automations page in your dashboard.

Response

Automation run queued successfully.

​
schemaId
string

The ID of the triggered automation.

​
instanceId
string

The ID of the queued automation run. Appears in the run history on the Automation Runs page.

​
jobId
string

The ID of the background job processing the run.