Zum Hauptinhalt springen

Nächstes Tool finden

DashboardAndroid-App
Sprache
Darstellung
MAXScanner APITestumgebung
API/Referenz/Webhook erstellen
POST/api/v1/webhooks

Webhook erstellen

Registriere ein signiertes Callback-Ziel für Job- und Dokumentereignisse.

Authentifizierung

API-Schlüssel

Berechtigungen

webhooks:write

Vertrag

API v1

Anfrage

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

Anfragetext

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

Antwort

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

Hinweise zur Implementierung

  • Nur HTTPS-Endpunkte.
  • Prüfe Signaturen und dedupliziere Ereignis-IDs.

Diesen Endpunkt testen

Nutze die API-Testumgebung, um dich zu authentifizieren und sicher zu testen, bevor du den Endpunkt in deine Anwendung einbindest.

Testumgebung öffnen →