> ## Documentation Index
> Fetch the complete documentation index at: https://adminroletesting-mintlify-999c9ea9.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Déclencher une automatisation
> Déclenchez immédiatement une automatisation planifiée, au lieu d'attendre sa prochaine heure planifiée. Utile pour exécuter des automatisations depuis des pipelines CI/CD, comme une GitHub Action qui s'exécute à chaque fusion sur votre branche par défaut. Seules les automatisations planifiées (avec un calendrier personnalisé) peuvent être déclenchées. L'exécution récupère les modifications effectuées depuis la dernière exécution terminée, à l'identique d'une exécution planifiée habituelle.
Utilisez cet endpoint pour déclencher à la demande une automatisation planifiée, au lieu d'attendre sa prochaine exécution planifiée. L'automatisation se comporte exactement comme une exécution planifiée habituelle : elle récupère tout ce qui a changé depuis la dernière exécution terminée.
Cet endpoint ne prend en charge que les automatisations configurées avec un déclencheur **Calendrier personnalisé**. Les requêtes pour des automatisations utilisant d'autres déclencheurs, comme **Modification de code** ou **Mise à jour de contenu**, renvoient une erreur `400`.
## Cas d'utilisation
* **Pipelines CI/CD** : Exécutez l'automatisation **Update from code changes** à chaque fusion dans `main`, afin que la documentation soit mise à jour au rythme de vos versions plutôt que selon un calendrier fixe.
* **Événements de version** : Exécutez l'automatisation **Draft changelog** lorsque vous créez un tag de version, afin que le changelog soit rédigé au moment même où la version est publiée.
* **Outillage personnalisé** : Déclenchez des automatisations depuis vos outils internes, des commandes Slack ou des tâches planifiées que vous exécutez déjà.
## Trouver l'identifiant de l'automatisation
Copiez l'identifiant de l'automatisation depuis le panneau de paramètres de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard.
## Exemple
Déclenchez une automatisation depuis une GitHub Action chaque fois que du code est fusionné dans `main` :
```yaml .github/workflows/trigger-docs.yml theme={null}
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 }}
```
## Limites de débit
Cet endpoint partage une limite de débit avec [Trigger update](/fr/api/update/trigger) : jusqu'à 5 requêtes par minute et par organisation. Les exécutions déclenchées consomment des crédits au même rythme que les exécutions planifiées.
## OpenAPI
````yaml fr/openapi.json POST /workflow/{projectId}/{workflowSchemaId}/trigger
openapi: 3.0.1
info:
title: Mintlify External API
description: Une API pour gérer la documentation Mintlify et accéder aux ressources.
version: 1.0.0
servers:
- url: https://api.mintlify.com/v1
security:
- bearerAuth: []
paths:
/workflow/{projectId}/{workflowSchemaId}/trigger:
post:
summary: Déclencher une automatisation
description: >-
Déclenchez immédiatement une automatisation planifiée, au lieu
d'attendre sa prochaine heure planifiée. Utile pour exécuter des
automatisations depuis des pipelines CI/CD, comme une GitHub Action qui
s'exécute à chaque fusion sur votre branche par défaut. Seules les
automatisations planifiées (avec un calendrier personnalisé) peuvent
être déclenchées. L'exécution récupère les modifications effectuées
depuis la dernière exécution terminée, à l'identique d'une exécution
planifiée habituelle.
parameters:
- name: projectId
in: path
description: >-
Identifiant de votre projet. Vous pouvez le copier à partir de la
page [API
keys](https://app.mintlify.com/settings/organization/api-keys) de
votre Dashboard.
required: true
schema:
type: string
- name: workflowSchemaId
in: path
description: >-
Identifiant de l'automatisation à déclencher. Vous pouvez le copier
depuis le panneau de paramètres de l'automatisation sur la page
[Automations](https://app.mintlify.com/products/automations) de
votre dashboard.
required: true
schema:
type: string
responses:
'202':
description: Exécution de l'automatisation mise en file d'attente avec succès.
content:
application/json:
schema:
type: object
properties:
schemaId:
type: string
description: Identifiant de l'automatisation déclenchée.
instanceId:
type: string
description: >-
Identifiant de l'exécution d'automatisation mise en file
d'attente. Apparaît dans l'historique des exécutions sur
la page [Automation
Runs](https://app.mintlify.com/products/automations).
jobId:
type: string
description: >-
Identifiant de la tâche d'arrière-plan qui traite
l'exécution.
'400':
description: >-
Requête non valide. L'identifiant de l'automatisation est mal formé,
l'automatisation n'est pas active, ou l'automatisation n'est pas
configurée avec un calendrier personnalisé.
content:
application/json:
schema:
type: object
properties:
error:
type: string
'404':
description: L'automatisation est introuvable ou n'appartient pas à ce projet.
content:
application/json:
schema:
type: object
properties:
error:
type: string
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé d’API
administrateur (préfixée par `mint_`). Il s’agit d’une clé secrète
utilisée côté serveur. Générez-en une depuis la page [API
keys](https://dashboard.mintlify.com/settings/organization/api-keys) de
votre Dashboard.
````