WorkOS を接続すると、ユーザーの作成、メールアドレスの確認、パスワードのリセット、組織への参加、ディレクトリ同期によるプロビジョニングをきっかけに、ブランドらしいメールを送れるようになります。Brew は、18種類の WorkOS イベントをオートメーションのトリガーに変えます。
SSO、ディレクトリ同期、ログイン、パスワードリセットは、引き続き WorkOS が担当します。Brew が行うのは、イベントを受け取り、それに続くメールを作成して送信することだけです。
organization.created、organization.updated、organization.deleted、connection.activated には受信者が含まれません。Brew はこれらを受信者不明として「最近のイベント」に記録し、オートメーションは開始しません。
新しい組織について人にメールを送るには、organization_membership.created や invitation.accepted など、その人のアドレスを含むイベントを使ってください。
メールアドレスのないメンバーシップ、認証、ディレクトリのイベントでも、同じ WorkOS ユーザー、メンバーシップ、ディレクトリユーザーの実際のメールアドレスを、現在の接続で Brew がすでに把握していれば、処理を続けられます。
Brew は、次の18種類のイベントに対応しています:
実際のメールアドレスを含む検証済みのイベントを受け取ると、オートメーションで使われているかどうかにかかわらず、Brew はメールアドレスで照合してコンタクトを作成または更新します。データがある場合、Brew は姓名、workos_user_id、workos_email_verified を設定します。
認証イベントでは、イベントに応じて workos_last_verification_at、workos_last_failed_auth_at、workos_last_password_reset_at、workos_last_magic_auth_at のいずれかが設定されます。メンバーシップと招待のイベントでは workos_organization_id と workos_org_role が、ディレクトリのイベントでは workos_directory_user_id と workos_directory_id が設定されます。
user.deleted と dsync.user.deleted は workos_account_status を deleted に、organization_membership.deleted は removed_from_org に設定します。Brew がコンタクトを削除することはありません。
差し込みタグには、選択したイベントで宣言されているペイロードのスキーマを使います。すべてのイベントに、値があれば email、firstName、lastName、createdAt が含まれます。ユーザーのイベントには emailVerified が、組織のイベントには organizationName が、メンバーシップと招待のイベントには role が加わります。createdAt は秒単位の Unix タイムスタンプです。
WorkOS オブジェクトのIDは差し込みタグにはなりません。認証イベントに含まれるIPアドレスとユーザーエージェントも同様です。
ディレクトリ同期で取り込んだ従業員は、通常、マーケティングメールの受信にオプトインしていません。個別にオプトインしていない限り、アカウントに関する通知やトランザクションメールの受信者として扱ってください。
イベントの受信とメールの送信は、別々のステップです。一致するオートメーションが稼働中であることを確認してから、そのフィルター、実行履歴、受信者が対象に含まれるかどうか、送信ドメインを確認してください。組織と接続のイベントでオートメーションが開始されることはありません。また、認識できる WorkOS のテストサンプルは、テストイベントとして記録されます。