Administration

Déclencher un webhook d'automatisation

Met en file d’attente une exécution d’automatisation personnalisée disposant d’un déclencheur webhook, au lieu d’attendre l’événement configuré du déclencheur. Utile pour exécuter des automatisations depuis des pipelines CI/CD, des scripts de publication ou tout autre système qui émet déjà des événements. Seules les automatisations personnalisées avec un déclencheur webhook peuvent être déclenchées ; les autres déclencheurs renvoient une réponse 404.

Authentifiez-vous avec une clé d’API d’organisation disposant d’un accès en écriture.

POST

workflow

{projectId}

{workflowSchemaId}

webhook

Déclencher un webhook d'automatisation

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

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.

Cas d’utilisation

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à.

Récupérer l’URL du webhook et l’en-tête d’authentification

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.

Exemple

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

Limites de débit

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.

Autorisations

Authorization

string

header

requis

L'en-tête Authorization requiert un jeton Bearer. Utilisez une clé d'API administrateur. Il s'agit d'une clé secrète côté serveur. Générez-en une depuis la page des clés d'API de votre Dashboard.

Paramètres de chemin

projectId

string

requis

L'identifiant de votre projet. Copiez-le depuis la page API keys de votre dashboard.

workflowSchemaId

string

requis

L'identifiant de l'automatisation à déclencher. Copiez-le depuis le panneau de paramètres de l'automatisation sur la page Automatisations de votre dashboard.

Réponse

Exécution d'automatisation mise en file d'attente avec succès.

success

boolean

runId

string

L'identifiant de l'exécution d'automatisation mise en file d'attente. Il apparaît dans l'historique des exécutions sur la page Automatisations.

⌘I

Déclencher un webhook d'automatisation

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

Référence de l’API

Administration

Agent

Assistant

Recherche

Mintlify Index

Analytics

Export statique

Déclencher un webhook d'automatisation

Cas d’utilisation

Récupérer l’URL du webhook et l’en-tête d’authentification

Exemple

Limites de débit

Autorisations

Paramètres de chemin

Réponse

​Cas d’utilisation

​Récupérer l’URL du webhook et l’en-tête d’authentification

​Exemple

​Limites de débit

Autorisations

Paramètres de chemin

Réponse

Cas d’utilisation

Récupérer l’URL du webhook et l’en-tête d’authentification

Exemple

Limites de débit