RECERQA ScanのWebhook設定
※システム管理者の権限が必要です。
※RECERQA ScanのWebhook設定はルールごとに設定します
Webhook設定を行うルールの「Webhook設定」メニューをクリックします。
権限がない場合は「Webhook設定」メニューは表示されませんので、その場合は管理者にご確認ください。
・JENKAのWebhook受信コネクタで発行されたURLをRECERQA ScanのWebhook設定のURLに入力し、保存します。
※RECERQA Scan側の画面の「有効」がオンの状態になっていることを確認してください。
JENKAのWebhook受信コネクタ設定
・Webhook受信コネクタの設定を下記のように設定した上で、「Wehoookを受信する」ボタンをクリックして待ちの状態にしてください。
※HTTPメソッド: POST
※認証方式: None
・上記の状態のまま、RECERQA Scanのルールにジョブを作成してOCR処理が完了すると、JENKAがRECERQA ScanからのWebhookを受信します。
※以下のように受信されたパラメータが表示されれば設定完了です。
・コネクタの設定を保存をして完了です。
※注意事項
・設定が完了しましたら、必ずワークフローの保存をお願いいたします。
保存せずに終了すると、改めてコネクタの設定が必要となります。
・すべての作成作業が完了しましたら、ワークフローを公開してください。
公開されていない状態では、RECERQA Scanからの通知を受信することができません。
受信するRECERQA Scanのデータについて
※下記のパラメータはRECERQA ScanのWebhook設定でイベントを「OCR完了時」にした場合に受信するデータになります。
他のイベントに設定した場合、受信するデータが一部変わりますので、ご注意ください。
| パラメータ | 説明 |
| event_type | Webhookイベントタイプ（ocr_ready, ocr_completed, ocr_failedのいずれか） |
| event_id | WebhookイベントID |
| timestamp | Webhookイベント発生時刻 |
webhook_version | WebHookのバージョン |
organization_id | 組織ID |
workflow_id | ルールID |
workflow_name | ルール名 |
upload_set_id | ジョブID |
upload_set_name | ジョブ名 |
created_at | 作成日時 |
updated_at | 更新日時 |
status | 処理状態 (ready, success, failedのいずれか) |
upload_set_total_page_count | アップロードセットの総ページ数 |
upload_set_init_page_count | アップロード時に登録されたページ数 |
processed_page_count | 処理済みページ数 |
started_at | 処理開始日時 |
completed_at | 処理完了日時 |