Saltar al contenido principal
POST
/
workflow
/
{projectId}
/
{workflowSchemaId}
/
trigger
Activar automatización
curl --request POST \
  --url https://api.mintlify.com/v1/workflow/{projectId}/{workflowSchemaId}/trigger \
  --header 'Authorization: Bearer <token>'
{
  "schemaId": "<string>",
  "instanceId": "<string>",
  "jobId": "<string>"
}
Usa este endpoint para activar bajo demanda una automatización programada, en lugar de esperar a su próxima ejecución programada. La automatización se comporta de forma idéntica a una ejecución programada normal: recoge todo lo que ha cambiado desde la última ejecución completada. Este endpoint solo admite automatizaciones configuradas con un activador de Programación personalizada. Las solicitudes para automatizaciones con otros activadores, como Cambio de código o Actualización de contenido, devuelven un error 400.

​
Casos de uso

  • Pipelines CI/CD: Ejecuta la automatización Update from code changes en cada fusión a main, para que la documentación se actualice según tu cadencia de versiones en lugar de hacerlo según una programación fija.
  • Eventos de versión: Ejecuta la automatización Draft changelog cuando creas una etiqueta de versión, para que el changelog se redacte al mismo tiempo que se publica la versión.
  • Herramientas personalizadas: Activa automatizaciones desde herramientas internas, comandos de Slack o tareas programadas que ya ejecutas.

​
Encuentra el ID de la automatización

Copia el ID de la automatización desde el panel de configuración de la automatización en la página Automatizaciones de tu dashboard.

​
Ejemplo

Activa una automatización desde una GitHub Action cada vez que se fusiona código a 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 }}

​
Límites de tasa

Este endpoint comparte un límite de tasa con Trigger update: hasta 5 solicitudes por minuto por organización. Las ejecuciones activadas consumen créditos al mismo ritmo que las ejecuciones programadas.

Autorizaciones

​
Authorization
string
header
requerido

El encabezado Authorization espera un token de tipo Bearer. Usa una clave de API de administrador (con el prefijo mint_). Esta es una clave secreta del lado del servidor. Genera una en la página de claves de API de tu dashboard.

Parámetros de ruta

​
projectId
string
requerido

El ID de tu proyecto. Puedes copiarlo de la página de API keys de tu dashboard.

​
workflowSchemaId
string
requerido

El ID de la automatización que se va a activar. Puedes copiarlo del panel de configuración de la automatización en la página Automatizaciones de tu dashboard.

Respuesta

Ejecución de la automatización puesta en cola correctamente.

​
schemaId
string

El ID de la automatización activada.

​
instanceId
string

El ID de la ejecución de la automatización puesta en cola. Aparece en el historial de ejecuciones en la página Ejecuciones de automatizaciones.

​
jobId
string

El ID del trabajo en segundo plano que procesa la ejecución.