Crea un webhook

Registra una destinazione di callback firmata per gli eventi di job e documenti.

Autenticazione

Chiave API

Ambiti

webhooks:write

Contratto

API v1

Richiesta

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

Corpo della richiesta

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

Risposta

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

Note di implementazione

Solo endpoint HTTPS.
Verifica le firme ed elimina i duplicati degli ID evento.

Prova questo endpoint

Usa l’ambiente di prova dell’API per autenticarti e testare in sicurezza prima di integrare l’endpoint nella tua applicazione.

Apri l’ambiente di prova →