イベントのウェブフックを追加する

イベントのウェブフックを追加するServer-side

post/projects/{project_id}/events/{event_type}/webhooks

指定されたイベントのウェブフックを作成します。ウェブフックのフォーマットは以下の通り：

{
    "event_type": "Event type",
    "event_time": "Date and time when the event occurred in the ISO 8601 format",
    "project_id": "Login project ID",
    "data": {
         // Some other data, can be different for different events and include nested objects
     }
}

SecurityServer

Request

path Parameters

project_id

required

string <uuid>

パブリッシャーアカウントからのログインプロジェクトID。

event_type

required

string

イベントタイプ。以下の値を指定できます：

registrationは、ログインとパスワードによるユーザー登録（JWTとOAuth 2.0）、ソーシャル認証（JWTとOAuth 2.0）、サイレント認証（JWTとOAuth 2.0）、電話番号による認証（JWTとOAuth 2.0）、およびサーバーから新規ユーザー登録に使用されます。
authorizationは、ログインとパスワードによるユーザー認証（JWTとOAuth 2.0）、ソーシャル認証（JWTとOAuth 2.0）、サイレント認証（JWTとOAuth 2.0）、電話番号による認証（JWTとOAuth 2.0）、およびサーバーから新規ユーザー登録に使用されます。
email_confirmationは、ユーザーのメールアドレスの確認に使用されます。 *link_social_accountは、ユーザーのソーシャルアカウントのリンクに使用されます。
new_verified_userは必要な認証ステップをすべて通過したときに、ユーザー登録に使用されます。検証ステップは、メールアドレスの確認、oknameサービス経由での年齢確認、追加のデータ収集などです。これらのステップを自分で構成する必要があります。

Enum: "registration" "authorization" "email_confirmation" "link_social_account" "new_verified_user"

Request Body schema: application/json

url

required

string <uri> <= 500 characters

エクソラログインサーバーがウェブフックを送信する有効なURL。

Responses

200

401

未認証

404

見つかりません

422

処理不可能なエンティティー

429

リクエストの回数が多すぎます

Request samples

application/json

{"url": "https://example.com/hook/second"
}

Response samples

application/json

{"id": 2342423,
"url": "https://example.com/hook/second"
}