Administración

Activar webhook de automatización

Pone en cola una ejecución de una automatización personalizada con un activador de webhook, en lugar de esperar al evento configurado del activador. Útil para ejecutar automatizaciones desde pipelines de CI/CD, scripts de publicación o cualquier otro sistema que ya emita eventos. Solo se pueden activar automatizaciones personalizadas con un activador de webhook; los demás activadores devuelven una respuesta 404.

Autentícate con una clave de API de organización con acceso de escritura.

POST

workflow

{projectId}

{workflowSchemaId}

webhook

Activar webhook de automatización

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

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.

Casos de uso

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.

Obtén la URL del webhook y el encabezado de autenticación

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.

Ejemplo

Activa una automatización de webhook 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/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 }}

Límites de tasa

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.

Autorizaciones

Authorization

string

header

requerido

El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador. 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. Cópialo desde la página API keys de tu dashboard.

workflowSchemaId

string

requerido

El ID de la automatización que se va a activar. Cópialo desde el panel de ajustes de la automatización en la página Automatizaciones de tu dashboard.

Respuesta

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

success

boolean

runId

string

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

⌘I

Activar webhook de automatización

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

Referencia de la API

Administración

Agente

Assistant

Búsqueda

Mintlify Index

Analytics

Exportación estática

Activar webhook de automatización

Casos de uso

Obtén la URL del webhook y el encabezado de autenticación

Ejemplo

Límites de tasa

Autorizaciones

Parámetros de ruta

Respuesta

​Casos de uso

​Obtén la URL del webhook y el encabezado de autenticación

​Ejemplo

​Límites de tasa

Autorizaciones

Parámetros de ruta

Respuesta

Casos de uso

Obtén la URL del webhook y el encabezado de autenticación

Ejemplo

Límites de tasa