イベントストリーム - Auth0 Docs

event-stream トリガーは、Auth0 テナント内で特定のイベントが発生したときに実行されます。各イベントストリーム Action はイベントストリームに関連付けられ、あらかじめ定義されたイベントタイプ (ログインの成功、パスワードの変更、ユーザーの削除など) を監視します。購読しているイベントが発生すると、Action がトリガーされます。Login または Pre-Registration Actions とは異なり、イベントストリーム Actions はバックグラウンドで実行され、ユーザーの主要なトランザクションには影響しません。

イベントストリーム Actions がテナントイベントを購読して処理する仕組みを示す図。

このフローの Actions はノンブロッキング (非同期) です。Auth0 パイプラインは Action の完了を待たずに実行を続けるため、Action の結果は Auth0 トランザクションに影響せず、ユーザー体験のレイテンシにも影響を与えません。

参照

イベントオブジェクト: イベントストリームメッセージとActionの実行の両方に関するコンテキストを提供します。
API オブジェクト: フローの動作を変更するためのメソッドを提供します。

一般的なユースケース

外部サービスにイベントを同期する

event-stream Action を使用すると、カスタムロジックに基づいて特定のイベントを外部サービスに通知できます。次の Action は、保存されている API key を使用して、イベントメッセージを外部サービスに安全に転送する方法を示しています。

/**
 * @param {Event} event - 受信したイベントの詳細。
 * @param {EventStreamAPI} api - イベントストリーム処理を定義するためのメソッドとユーティリティ。
 */
exports.onExecuteEventStream = async (event, api) => {
  const message = event.message;

  try {
    await fetch(event.secrets.URL, {
      method: 'POST',
      headers: {
        'X-API-Key': event.secrets.API_KEY,
      },
      body: JSON.stringify(message),
    });
  } catch (err) {
    throw new Error('External service failure');
  }

  return;
};

詳細はこちら