Déclencher un webhook d'automatisation

Utilisez cet endpoint pour exécuter une automatisation personnalisée configurée avec un déclencheur Webhook. Chaque requête met en file d’attente une exécution qui utilise le prompt enregistré de l’automatisation et lit l’historique complet du dépôt. Les corps de requête sont ignorés.

Cet endpoint ne prend en charge que les automatisations personnalisées avec un déclencheur webhook. Les automatisations prédéfinies et les automatisations avec tout autre déclencheur renvoient une réponse 404. Pour déclencher à la demande une automatisation personnalisée planifiée, utilisez Déclencher une automatisation.

• Pipelines CI/CD : Exécutez une automatisation personnalisée à chaque fusion dans main ou après une publication, sans attendre une exécution planifiée.
• Événements de publication : Exécutez une automatisation personnalisée depuis un script de publication lorsque vous créez un tag ou publiez une nouvelle version de SDK.
• Outillage interne : Déclenchez des automatisations depuis des dashboards internes, des commandes Slack ou des tâches planifiées que vous exécutez déjà.

Ouvrez la page Automatisations dans votre dashboard et cliquez sur le bouton de paramètres d’une automatisation personnalisée avec un déclencheur webhook. La carte du déclencheur affiche l’URL complète du webhook et une action Copy auth header pour le modèle d’en-tête Authorization: Bearer <api-key>.

Remplacez <api-key> par une clé d’API d’organisation non expirée avec accès en écriture. Créez ou gérez les clés sur la page API keys. Les automatisations ne créent, ne stockent ni ne font tourner de clés à votre place.

Déclenchez une automatisation webhook depuis une GitHub Action chaque fois que du code est fusionné dans 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 }}

Cet endpoint partage une limite de débit avec Trigger update et Déclencher une automatisation : jusqu’à 10 requêtes par tranche de 10 secondes et par organisation. Chaque exécution mise en file d’attente consomme des crédits au même rythme que n’importe quelle autre exécution d’automatisation personnalisée. Consultez Tarification des crédits.