Webhook
Webhook に関する設定をします。設定は、全ての Webhook 通知に適用されます。
また、ログイン／ログアウト 時に通知する Webhook を設定します。
設定
基本設定
全ての Webhook 通知に適用されます。
送信タイムアウト時間
HTTP 通信のタイムアウト時間を指定します。
送信リトライ回数
通知に失敗した場合のリトライ回数を指定します。HTTP 通信がタイムアウトした、通知先からエラーが返された場合にリトライします。
送信リトライ間隔
通知に失敗した場合のリトライ間隔を指定します。単位は秒もしくはミリ秒です。
同一のWebhookで発生したエラーをメールで通知しない間隔
同一のWebhookで発生したエラーをメールで通知しない間隔を指定します。単位は分もしくは時間です。
通知設定
ログイン／ログアウト 時に通知する Webhook を設定します。
ログイン/ログアウト時に通知
「する」を選択すると、ログイン／ログアウト時に Webhook による通知を実行します。
ログイン/ログアウト時の通知先URL
通知先URLを設定します。URLは、通知先のサービスにてご確認ください。
6ログイン/ログアウト時の識別キー
識別キーを設定します。任意の文字列を入力します。通知先がリクエストの妥当性を判断する、などの目的に使用します。
使用できる文字は、半角英数字（大文字・小文字）と _ です。
連続通知設定
全ての Webhook 通知に適用されます。
チェック時間
送信間隔を指定します。単位は秒もしくはミリ秒です。
チェック時間にリクエスト可能な最大回数 とともに設定します。
チェック時間にリクエスト可能な最大回数
チェック時間 で指定した時間内に何回 Webhook 通知を送信するか指定します。
送信回数には、リトライでの再送も含みます。
たとえば、チェック時間 に「5」秒、チェック時間にリクエスト可能な最大回数 に「3」回を設定すると、5 秒間に 3 回送信します。最初の 5 秒間で 1 ～ 3 件目を送信します。3 回の通信が終わり、残り時間がある場合は待機します。次の 5 秒間で 4 件 ～ 6 件目を送信します。
更新
クリックすると、システムに反映します。
JSON
Webhook では JSON 形式でデータを送信します。
フィールド
- application
-
アプリケーション名です。
「RakWDB」固定です。 - eventTime
-
操作した日時です。
- type
-
処理区分です。
ログインloginログアウトlogout - langid
-
言語区分です。
ユーザーがどの言語で楽々Wedデータベースを使用しているかを出力します。日本語0英語1中国語2 - key
-
ログイン/ログアウト時の識別キー で入力した値です。
入力した場合のみ出力します。入力しなかった場合はフィールドがありません。 - login
-
認証結果です。
フィールド名はログイン／ログアウトともに「login」です。"login": { "action": "1", "userid": "aa010001" }- action
-
認証結果を示すコードです。
ログイン成功1ログアウト成功2ログイン失敗-1自動ログアウト-2 - userid
-
ログイン／ログアウトしたユーザーのユーザーIDです。
例 ログイン
{
"application": "RakWDB",
"eventTime": "2022-10-18 10:48:09",
"type": "login",
"langid": "0",
"key": "samplekey",
"login": {
"action": "1",
"userid": "aa010001"
}
}
例 ログアウト
{
"application": "RakWDB",
"eventTime": "2022-10-26 09:45:42",
"type": "logout",
"langid": "0",
"key": "samplekey",
"login": {
"action": "2",
"userid": "aa010001"
}
}
管理
送信に失敗したWebhookの一覧を表示します。
システム管理者、管理者の場合は、全てのWebhookのエラーを表示します。
アプリ管理者の場合は、管理対象のアプリのWebhookのエラーのみを表示します。
送信日時
送信日時を表示します。
送信先URL
送信先URLを表示します。
レスポンスステータス
送信先サーバーからのレスポンスのHTTPステータスコードを表示します。
種別
Webhookを通知した操作の種別を表示します。
アプリコード
アプリコードを表示します。
アプリ名
アプリ名を表示します。
照会
送信に失敗したWebhookの詳細情報を表示します。
送信日時
送信日時を表示します。
送信先URL
送信先URLを表示します。
レスポンスステータス
送信先サーバーからのレスポンスのHTTPステータスコードを表示します。
レスポンスボディ
送信先サーバーからのレスポンスのボディを表示します。
種別
Webhookを通知した操作の種別を表示します。
アプリコード
アプリコードを表示します。
アプリ名
アプリ名を表示します。
送信内容
Webhookで送信した内容を表示します。