Create a webhook

Authentication

API key

Scopes

webhooks:write

Contract

API v1

Request

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

Request body

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

Response

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

Implementation notes

HTTPS endpoints only.
Verify signatures and deduplicate event IDs.

Try this endpoint

Use the API Playground to authenticate and test safely before wiring the endpoint into your application.

Open Playground →