Hubungkan Clerk untuk memulai email bermerek saat seseorang mendaftar, bergabung dengan organisasi, memulai langganan Clerk Billing, atau masuk ke daftar tunggu Anda. Clerk menandatangani setiap webhook, dan Brew mengubah 13 jenis peristiwa menjadi pemicu otomatisasi.
Clerk tetap bertanggung jawab atas proses masuk, organisasi, dan penagihan. Brew hanya menerima peristiwa. Brew tidak dapat mengubah pengguna, membuat organisasi, atau menagih langganan.
organization.created tidak membawa alamat email. Brew mencari ID pengguna pembuatnya di antara identitas yang sudah pernah dilihatnya dalam peristiwa Clerk sebelumnya pada koneksi saat ini. Jika Brew menemukan alamat email sungguhan, peristiwa itu diproses. Jika tidak, Brew mencatat peristiwa itu sebagai peristiwa tanpa penerima, tidak membuat kontak, dan tidak memulai otomatisasi.
Atur endpoint agar juga berlangganan user.created, supaya Brew dapat mengetahui alamat email para pembuat organisasi. Untuk email yang harus selalu sampai ke seseorang, gunakan organizationMembership.created, yang membawa alamat email anggota.
Brew mendukung 13 jenis peristiwa berikut:
Setiap peristiwa terverifikasi yang memiliki alamat email sungguhan akan membuat atau memperbarui kontak Brew, yang dicocokkan berdasarkan email, baik peristiwa itu dipakai otomatisasi maupun tidak. Jika datanya tersedia, Brew mengisi nama depan, nama belakang, dan clerk_user_id.
user.created juga mengisi clerk_username, clerk_image_url, clerk_signed_up_at, dan clerk_last_sign_in_at. Peristiwa undangan dan keanggotaan mengisi clerk_organization_id, clerk_org_role, dan clerk_org_role_name. Peristiwa undangan menambahkan clerk_org_invitation_status, sedangkan peristiwa keanggotaan menambahkan clerk_organization_name dan clerk_organization_slug.
Peristiwa penagihan mengisi clerk_subscription_status dan clerk_plan_name, dan sebagian juga menambahkan clerk_plan_slug, clerk_subscription_period_end, atau clerk_is_trialing. paymentAttempt.created mengisi clerk_last_payment_attempt_status dan clerk_last_payment_attempt_at. waitlistEntry.created mengisi clerk_waitlist_status.
Gunakan skema payload yang dideklarasikan untuk peristiwa terpilih sebagai acuan merge tag. Setiap peristiwa menyertakan email, firstName, lastName, dan createdAt. Field lainnya bergantung pada peristiwanya, seperti planName, planAmount, roleName, organizationName, dan grandTotalFormatted. planAmount dan grandTotalAmount dinyatakan dalam satuan mata uang terkecil, jadi dalam USD, nilai 2000 berarti US$20,00. Stempel waktu dinyatakan dalam detik Unix.
ID objek Clerk, seperti ID pengguna, organisasi, dan langganan, tidak tersedia sebagai merge tag. ID pengguna disimpan di kontak sebagai clerk_user_id.
Akun Clerk tidak membuktikan adanya persetujuan untuk email pemasaran. Catat persetujuan saat pendaftaran dan periksa sebelum pengiriman promosi.
Tidak selalu. Brew hanya menerima paymentAttempt.created, bukan pembaruan berikutnya atas percobaan pembayaran tersebut. Field status pada peristiwa ini bisa bernilai pending, paid, atau failed, tetapi pembayaran yang gagal setelah percobaannya dibuat akan sampai ke Brew sebagai peristiwa yang tidak didukung. Untuk pembayaran yang terlewat, gunakan subscriptionItem.pastDue. Untuk menampilkan total di teks email, grandTotalFormatted berisi nilai yang sudah diformat, seperti $22.00.
Menerima peristiwa dan mengirim email adalah dua langkah terpisah. Pastikan otomatisasi yang cocok berstatus Aktif, lalu periksa filter dan riwayat eksekusinya, kelayakan penerima, serta domain pengirim. Pengiriman lewat Send Example memverifikasi webhook tetapi tidak pernah memulai otomatisasi, dan peristiwa organization.created tanpa pembuat yang dikenal dicatat sebagai peristiwa tanpa penerima.