イベントカタログの概要 - Auth0 Docs

イベントは、Auth0 テナント内で発生した特定の操作に関するリアルタイム通知です。現時点では主にユーザーや組織に対する変更が対象ですが、今後さらに対象が広がる予定です。これらのイベントを監視するイベントストリームを作成すると、Auth0 内の非同期な変更 (つまり、エンティティやフローに対してすでに完了した変更) をオーケストレーションし、外部で処理するためにさまざまな送信先のいずれかへ転送できます。イベントは、次のようなさまざまな利用例をサポートします。

新規顧客に歓迎メールを送信したり、メールアドレスの確認を依頼したりする。
ユーザーのライフサイクルの変化を監視して、CRM (顧客関係管理) や課金システムを更新できるようにする。

イベントオブジェクトのスキーマ

イベントは、CloudEvent仕様に準拠したスキーマを使用して発行されます。

パラメータ	型	必須	説明
id	string	はい	イベントを識別します。
source	URI-reference	はい	環境を含む、イベントを生成したテナントを識別します。
specversion	string	はい	イベントで使用されるCloudEvents仕様のバージョンです。
type	string	はい	イベントのタイプです。
time	timestamp	はい	イベントが発生した日時を示すタイムスタンプです。
dataschema	URI	はい	データが準拠するschemaを識別します。
data	object	はい	イベントに関する追加情報です。このfieldはイベントのタイプによって異なります。

{
  "id": "evt_<unique-id>",
  "source": "urn:auth0:<your-tenant>:users",
  "spec_version": "1.0",
  "type": "com.auth0.user.<event-type>",
  "time": "2025-01-29T14:36:25.794Z",
  "dataschema": "https://<your-tenant>.auth0.com/api/v2/schemas/user.<event-type>",
  "data": {
    "object": {
      "user_id": "<user-id>",
      "email": "<email>",
      "email_verified": <true/false>,
      "family_name": "<family-name>",
      "given_name": "<given-name>",
      "name": "<full-name>",
      "nickname": "<nickname>",
      "phone_number": "<phone-number>",
      "phone_verified": <true/false>,
      "user_metadata": {
        "hobby": "<user-hobby>"
      },
      "app_metadata": {
        "external_user_id": "<external-id>"
      },
      "identities": [
        {
          "connection": "<connection-name>",
          "user_id": "<identity-user-id>",
          "provider": "<identity-provider>",
          "isSocial": <true/false>
        }
      ],
      "created_at": "<user-created-time>",
      "updated_at": "<user-updated-time>",
      "picture": "<profile-picture-url>"
    }
  }
}

リソース

読む…	学べること…
イベントストリームを作成する	イベントストリームの使い始め方。
イベントのテスト、可観測性、障害復旧	稼働中のイベントストリームをテストおよび管理する方法。
イベントのベストプラクティス	イベントを扱う際のベストプラクティス。