バインダのWebhook

概要

Webhookの仕組みを使うことで、文書の登録、更新、削除、ワークフローの承認などのタイミングで、外部システムのURLを呼び出すことができます。

定義

Webhookの設定を行うバインダの文書一覧画面にて、サイドメニューから「Webhook」メニューをクリックします。

※定義可能な権限は、管理者です。

Webhookの一覧画面が表示されます。この画面からWebhookの定義を行います。

表 Webhook一覧画面

列名	説明
ID	WebhookのIDが表示されます。
タイプ	Webhookのタイプが表示されます。
有効	Webhookの有効/無効が表示されます。
Webhook名	Webhookの名前が表示されます。Webhook名をクリックすると定義編集画面が表示されます。
URL	Webhookで呼び出すURLが表示されます。
説明	Webhookの説明が表示されます。
最終更新	Webhookの最終更新日時と最終更新ユーザが表示されます。
実行履歴	「詳細」ボタンを押下すると実行履歴画面が表示されます。

「新規登録」ボタンを押下すると、Webhook新規作成画面が表示されます。

Webhookのタイプを選択します。

※選択できるタイプには、「文書登録」、「文書更新」、「文書削除」があります。

表 Webhookのタイプと呼び出すタイミング

タイプ	呼び出すタイミング
文書新規	・文書新規画面からの文書新規 ・RestAPIでの文書新規 ・公開APIでの文書新規（オプション） ・文書作成ロボットでの文書新規
文書更新	・文書更新画面からの文書更新 ・RestAPIでの文書更新 ・公開APIでの文書更新（オプション） ・イベントハンドラ「文書代入」での文書更新
文書削除	・文書削除画面からの文書削除 ・RestAPIでの文書削除 ・公開APIでの文書削除（オプション）

Webhookの定義画面に必要項目を入力します。

既存のWebhookを編集する場合は、Webhook一覧画面でWebhook名をクリックします。

表 Webhook定義画面の項目

項目名	説明	選択方法・指定可能範囲　など
タイプ	新規登録時にプルダウンメニューで選択したタイプです。	編集できません。
ID	WebhookのIDです。	編集できません。
Webhook名*	Webhook名を設定します。	任意の文字列を入力します。
説明	Webhookの説明を設定します。	任意の文字列を入力します。
有効	Webhookの有効/無効を設定します。	チェックボックスにチェックを入れると有効になります。 有効である場合しか送信しません。
URL*	Webhookで呼び出すURLを設定します。	「http://」または「https://」で始まる必要があります。
HmacSHA256キー	HmacSHA256キーを設定します。	任意のキーを入力します。 送信時に、指定したキーとHmacSHA256アルゴリズムでJSON文に対して、証明コードを計算し、拡張ヘッダ「X-SmartDB-Signature」に保存します。 （証明コードはBase64でエンコードされます。）
Basic認証	Basic認証を利用するかどうかを設定します。	チェックボックスにチェックを入れると利用になります。 認証のためのユーザ名とパスワードを指定します。
ヘッダ	リクエストヘッダをカスタマイズします。	チェックボックスにチェックを入れるとカスタマイズ可能になります。 KEY/VALUEの組み合わせを追加します。 "X-SmartDB"から開始するKEYは予約語のため利用できません。
条件	Webhookの送信条件を設定します。	「選択」ボタンを押下して、フィルター定義を選択します。

※ [*]は入力必須項目です。