Webhooks

ドキュメントがファイルキャビネットに新しく保存される、または関連するインデックスエントリが変更された場合に、他のビジネスアプリケーションに通知します。指定したドキュメントのインデックスデータを、メッセージの内容に含めることができます。会社の他のアプリケーションは、データストックを同期したり、特定のアクションやワークフローをトリガーしたりすることができます。

DocuWare は、2 つのアプリケーションを「フック」する (Webhook) URL を介してサードパーティアプリケーションと通信します。DocuWare は、通知を POST リクエストとしてサードパーティアプリケーションを監視している URL に送信します。同様に、メッセージを受信します。

例えば、新しいプレゼンテーションが DocuWare ファイルキャビネットに保存されると、このプロジェクトの共有の Microsoft Teams チャネルに通知が送信されるため、関連するすべての従業員がシームレスに情報を受け取ることができます。

要件

Webhook をご利用いただけるのは、DocuWare Cloud および DocuWare オンプレミスのお客様のみです。ただし、DocuWare 構成で、モジュールが表示されるのは、組織管理者の役割が割り当てられているユーザーのみです。

構成

Webhook を作成するには、最初に、[DocuWare 構成] > [統合] で REST タイプ Web サービスを設定します。Web サービスで、DocuWare と受信側のアプリケーションが相互に通信するための URL を入力します。

次に、[統合] > [Webhook] モジュールに移動し、通知を構成します。

イベント

[イベント] タブで、URL とファイルキャビネット (通知を送信するドキュメントを含む) を使用して Web サービスを指定します。ファイルキャビネットの通知では 2 種類の操作がトリガーされます。新しいドキュメントの保管作業、またはすでに保管されているドキュメントのインデックスデータの変更です。

次に、フィルターを使用して、通知が送信されるドキュメントを選択します。

テーブルフィールドの内容は POST リクエストで転送することはできません。

HTTP Request Body

本文には、通知の内容が含まれています。デフォルトでは、ファイルキャビネットのインデックスフィールドには、[イベント] で選択したドキュメントのインデックスデータがすでに挿入されています。データ形式は JSON です。

コンテンツを編集したり、変更したりすることができます。例えば、インデックスデータを特定の形式で受信側のアプリケーションに送信する場合などです。重要なことは、有効な JSON 形式が通知されることです。

「プレースホルダー」の値を使用して、関連するインデックスデータを渡します。このプレースホルダーは、マウスをクリックするだけで、各インデックスフィールドの JSON エディターに簡単に挿入することができます。

[検証とフォーマット] ボタンをクリックすると、本文にエラーが表示されます。正しくない行は強調表示され、説明が表示されます。検証は保存時に自動的に実行されます。エラーが発生した場合、Webhook は保存されません。

権限

ユーザーごとに個別に、あるいは役割に基づいて、通常の方法で各構成に Webhook の権限を割り当てることができるようになりました。ユーザーは権限が許可されている Webhook のみを表示、編集、削除できます。