Webhookにアラートを通知する

概要

Lockedの特定の挙動をトリガーとしてシステムを連携し、何かしらの自動処理を組み込まれたい場合、Webhookを活用することができます。

例: ・認証処理をトリガーに、独自の認証メールを送信する ・認証拒否をトリガーに、自動的にサポートのチケットを作成する ・認証拒否をトリガーに、アプリ内に通知を作成する

Webhookによる連携を利用されたい場合、ダッシュボードにログイン後確認できる、左側のメニューから確認できる「Webhook登録」にて取得・更新ができます。

送信されるパラメータ

Webhookは通常、「本人確認を承認・否認」「認証要求を許可・拒否」のタイミングで事前に設定されたエンドポイントにリクエストが飛びます。

これら以外にも特定のイベントを起点にWebhookを受け取る事ができます。ご希望の際は営業担当までご連絡ください。

{
 "api_version": "1", # イベントが発生したapi_version
 "type": "$monitor.create", # 発生したイベントの種類($monitor.create / $login.attempt)
 "created_at": "2020-01-17 13:03:11 +0900", # イベントが発生した時刻
 "data": {
   "id": "550fb1cd-ecb1-40de-8391-ef7ff97c557a", # イベント毎に一意なid
   "token": nil, # $login.attemptの場合、認証用のトークンが入ります
   "user_id": "7298", # 発生したイベントに紐づくエンドユーザーのid
   "confirm_result": "allow", # 承認/非承認の結果が入ります(allow・deny)
   "context": {
     "ip": "224.62.23.86", # イベントが発生したIPアドレス
     "location": {
       "country_name": "Turks and Caicos Islands", # イベントが発生した国
       "region_name": "福井県", # イベントが発生した地域
       "city": "南工藤郡", # イベントが発生した都市
       "latitude": "40.35202161900037", # イベントが発生した緯度
       "longitude": "78.79520636535119"}, # イベントが発生した経度
     "user_agent": {
       "browser_name": "Mobile Safari", # イベントが発生したブラウザの名前
       "browser_version": "11.0", # イベントが発生したブラウザのバージョン
       "os_name": "iOS", # イベントが発生したOSの種類
       "os_version": "11.0" # イベントが発生したOSのバージョン
      }
    }
  }
}

Last updated