Activar webhook de automatización

Usa este endpoint para ejecutar una automatización personalizada configurada con un activador de Webhook. Cada solicitud pone en cola una ejecución que usa el prompt guardado de la automatización y lee el historial completo del repositorio. Los cuerpos de solicitud se ignoran.

Este endpoint solo admite automatizaciones personalizadas con un activador de webhook. Las automatizaciones predefinidas y las automatizaciones con cualquier otro activador devuelven una respuesta 404. Para activar bajo demanda una automatización personalizada programada, usa Activar automatización.

• Pipelines CI/CD: Ejecuta una automatización personalizada en cada fusión a main o después de una publicación, sin esperar a una ejecución programada.
• Eventos de publicación: Ejecuta una automatización personalizada desde un script de publicación cuando creas una etiqueta o publicas una nueva versión de un SDK.
• Herramientas internas: Activa automatizaciones desde dashboards internos, comandos de Slack o tareas programadas que ya ejecutas.

Abre la página de Automatizaciones en tu dashboard y haz clic en el botón de ajustes de una automatización personalizada con un activador de webhook. La tarjeta del activador muestra la URL completa del webhook y una acción Copy auth header para la plantilla del encabezado Authorization: Bearer <api-key>.

Sustituye <api-key> por una clave de API de organización sin caducar con acceso de escritura. Crea o gestiona claves en la página API keys. Las automatizaciones no crean, almacenan ni rotan claves por ti.

Activa una automatización de webhook desde una GitHub Action cada vez que se fusiona código a main:

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 }}

Este endpoint comparte un límite de tasa con Trigger update y Activar automatización: hasta 10 solicitudes cada 10 segundos por organización. Cada ejecución en cola consume créditos al mismo ritmo que cualquier otra ejecución de una automatización personalizada. Consulta Precios de créditos.