Saltar al contenido principal

Encuentra tu próxima herramienta

API/Referencia/Crear un webhook
POST/api/v1/webhooks

Crear un webhook

Registra un destino de callback firmado para eventos de trabajos y documentos.

Autenticación

Clave de API

Permisos

webhooks:write

Contrato

API v1

Solicitud

curl -X POST 'https://api.maxscanner.app/api/v1/webhooks' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: unique-request-id' \
  -d '{ "url": "https://example.com/maxscanner/webhook", "events": ["job.completed"] }'

Cuerpo de la solicitud

{ "url": "https://example.com/maxscanner/webhook", "events": ["job.completed"] }

Respuesta

{ "id": "wh_123", "status": "active" }

Notas de implementación

  • Solo endpoints HTTPS.
  • Verifica las firmas y elimina los ID de evento duplicados.

Prueba este endpoint

Usa el entorno de pruebas de la API para autenticarte y probar con seguridad antes de integrar el endpoint en tu aplicación.

Abrir el entorno de pruebas →