Trigger automation webhook

POST

workflow

{projectId}

{workflowSchemaId}

webhook

Trigger automation webhook

curl --request POST \
  --url https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "runId": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Use this endpoint to run a custom automation with a Webhook trigger. Each request queues a run that uses the automation’s saved prompt and reads the full repository history. This endpoint ignores request bodies. This endpoint only supports custom automations with a webhook trigger. Predefined automations and automations with any other trigger return a 404 response. To trigger a scheduled custom automation on demand instead, use Trigger automation.

Use cases

CI/CD pipelines: Run a custom automation on every merge to main or after a release, without waiting for a scheduled run.
Release events: Run a custom automation from a release script when you cut a tag or publish a new SDK version.
Internal tooling: Trigger automations from internal dashboards, Slack commands, or scheduled jobs you already run.

Get the webhook URL and auth header

Open the Automations page in your dashboard and click the settings button on a custom automation with a webhook trigger. The trigger card shows the full webhook URL and a Copy auth header action for the Authorization: Bearer <api-key> header template. Replace <api-key> with an unexpired organization API key with write access. Create or manage keys on the API keys page. Automations do not create, store, or rotate keys on your behalf.

Example

Trigger a webhook 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/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 }}

Rate limits

This endpoint shares a rate limit with Trigger update and Trigger automation: up to 10 requests per 10 seconds per organization. Each queued run consumes credits at the same rate as any other custom automation run. See Credit pricing.

Authorizations

Authorization

string

header

required

The Authorization header expects a Bearer token. Use an admin API key. 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. Copy it from the API keys page in your dashboard.

workflowSchemaId

string

required

The ID of the automation to trigger. Copy it from the automation's settings panel on the Automations page in your dashboard.

Response

Automation run queued successfully.

success

boolean

runId

string

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

⌘I

Trigger automation webhook

curl --request POST \
  --url https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v2/workflow/{projectId}/{workflowSchemaId}/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "runId": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

API reference

Admin

Agent

Assistant

Search

Mintlify Index

Analytics

Static export

Trigger automation webhook

Use cases

Get the webhook URL and auth header

Example

Rate limits

Authorizations

Path Parameters

Response

​Use cases

​Get the webhook URL and auth header

​Example

​Rate limits

Authorizations

Path Parameters

Response

Use cases

Get the webhook URL and auth header

Example

Rate limits