Clerk を接続すると、新規登録、組織への参加、Clerk Billing のサブスクリプション開始、ウェイトリストへの登録をきっかけに、ブランドらしいメールを送れるようになります。Clerk が各 Webhook に署名し、Brew が13種類のイベントをオートメーションのトリガーに変えます。
ログイン、組織、請求は、引き続き Clerk が担当します。Brew はイベントを受け取るだけです。ユーザーの変更、組織の作成、サブスクリプションへの課金はできません。
organization.created にはメールアドレスが含まれません。Brew は、現在の接続でこれまでに受け取った Clerk イベントで把握しているユーザーの中から、作成者のユーザーIDを探します。実際のメールアドレスが見つかれば、イベントは処理されます。見つからなければ、Brew はそのイベントを受信者不明として記録し、コンタクトの作成もオートメーションの開始も行いません。
Brew が作成者のアドレスを把握できるよう、user.created も購読してください。毎回必ず誰かに届ける必要があるメールには、メンバーのアドレスを含む organizationMembership.created を使います。
Brew は、次の13種類のイベントに対応しています:
実際のメールアドレスを含む検証済みのイベントを受け取ると、オートメーションで使われているかどうかにかかわらず、Brew はメールアドレスで照合してコンタクトを作成または更新します。データがある場合、Brew は姓名と clerk_user_id を設定します。
user.created では、clerk_username、clerk_image_url、clerk_signed_up_at、clerk_last_sign_in_at も設定されます。招待とメンバーシップのイベントでは、clerk_organization_id、clerk_org_role、clerk_org_role_name が設定されます。さらに、招待では clerk_org_invitation_status が、メンバーシップでは clerk_organization_name と clerk_organization_slug が加わります。
請求イベントでは clerk_subscription_status と clerk_plan_name が設定され、イベントによっては clerk_plan_slug、clerk_subscription_period_end、clerk_is_trialing も加わります。paymentAttempt.created では clerk_last_payment_attempt_status と clerk_last_payment_attempt_at が、waitlistEntry.created では clerk_waitlist_status が設定されます。
差し込みタグには、選択したイベントで宣言されているペイロードのスキーマを使います。すべてのイベントに email、firstName、lastName、createdAt が含まれます。そのほかのフィールドはイベントによって異なり、planName、planAmount、roleName、organizationName、grandTotalFormatted などがあります。planAmount と grandTotalAmount は通貨の最小単位で表されるため、USDの場合、2000は$20.00です。タイムスタンプは秒単位の Unix 時間です。
ユーザー、組織、サブスクリプションのIDなど、Clerk オブジェクトのIDは差し込みタグにはなりません。ユーザーIDは、clerk_user_id としてコンタクトに保存されます。
Clerk のアカウントがあるだけでは、マーケティングメールの受信に同意したことにはなりません。登録時に同意を記録し、プロモーションメールを送る前に確認してください。
確実には送れません。Brew が受け取るのは paymentAttempt.created だけで、その後の支払い試行の更新は受け取りません。status フィールドの値は pending、paid、failed のいずれかになりますが、支払い試行の作成後に失敗した支払いは、未対応のイベントとして Brew に届きます。支払いが滞った場合の通知には、subscriptionItem.pastDue を使ってください。メールの文面に合計金額を入れるなら、$22.00のように整形済みの値が入った grandTotalFormatted を使えます。
イベントの受信とメールの送信は、別々のステップです。一致するオートメーションが稼働中であることを確認してから、そのフィルター、実行履歴、受信者が対象に含まれるかどうか、送信ドメインを確認してください。「Send Example」による配信は Webhook を検証するだけで、オートメーションを開始することはありません。また、作成者がわからない organization.created イベントは、受信者不明として記録されます。