Criar um webhook

Registre um destino de callback assinado para eventos de jobs e documentos.

Autenticação

Chave de API

Escopos

webhooks:write

Contrato

API v1

Requisição

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 da requisição

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

Resposta

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

Notas de implementação

Somente endpoints HTTPS.
Verifique as assinaturas e remova IDs de evento duplicados.

Experimente este endpoint

Use o ambiente de testes da API para se autenticar e testar com segurança antes de integrar o endpoint ao seu aplicativo.

Abrir o ambiente de testes →