POST
/api/v1/webhooksCréer un webhook
Enregistrez une destination de callback signée pour les événements de tâches et de documents.
Authentification
Clé d’API
Portées
webhooks:write
Contrat
API v1
Requête
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"] }'Corps de la requête
{ "url": "https://example.com/maxscanner/webhook", "events": ["job.completed"] }Réponse
{ "id": "wh_123", "status": "active" }Notes d’implémentation
- Endpoints HTTPS uniquement.
- Vérifiez les signatures et dédoublonnez les identifiants d’événement.
Essayer cet endpoint
Utilisez le bac à sable de l’API pour vous authentifier et tester sans risque avant d’intégrer l’endpoint à votre application.
Ouvrir le bac à sable →