メインコンテンツへ移動

次に使うツールを探す

ダッシュボードAndroid アプリ
言語
表示
MAXScanner APIプレイグラウンド
API/リファレンス/Webhook を作成
POST/api/v1/webhooks

Webhook を作成

ジョブやドキュメントのイベント用に、署名付きのコールバック先を登録します。

認証

API キー

スコープ

webhooks:write

契約

API v1

リクエスト

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

リクエスト本文

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

レスポンス

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

実装上の注意

  • HTTPS のエンドポイントのみ対応しています。
  • 署名を検証し、イベント ID の重複を除いてください。

このエンドポイントを試す

エンドポイントをアプリに組み込む前に、API プレイグラウンドで認証して安全にテストしましょう。

プレイグラウンドを開く →