IntegraçãoGatilhos de eventos de autenticação
Conecte o Clerk para disparar e-mails com a cara da sua marca quando alguém se cadastra, passa a fazer parte de uma organização, inicia uma assinatura do Clerk Billing ou entra na sua lista de espera. O Clerk assina cada webhook, e o Brew transforma 17 tipos de evento em gatilhos de automação.
O Clerk continua responsável pelo login, pelas organizações e pela cobrança. O Brew só escuta os eventos: ele não pode alterar usuários, criar organizações nem cobrar assinaturas.
O evento organization.created não traz nenhum endereço de e-mail. O Brew procura o ID de usuário do criador entre as identidades que já viu em eventos anteriores do Clerk, na conexão atual. Se encontrar um e-mail real, o evento segue adiante. Se não, o Brew registra o evento com um destinatário não resolvido, não cria nenhum contato e não inicia nenhuma automação.
Inscreva o endpoint também no user.created, para que o Brew conheça os endereços dos criadores. Para um e-mail que precisa chegar a uma pessoa todas as vezes, use o organizationMembership.created, que traz o endereço do membro.
O Brew é compatível com estes 17 tipos de evento:
Cada evento verificado com um endereço de e-mail real cria ou atualiza um contato do Brew, identificado pelo e-mail, independentemente de alguma automação usar o evento. Quando o evento traz esses dados, o Brew preenche o nome, o sobrenome e o campo clerk_user_id.
Os eventos user.created e user.updated preenchem clerk_account_status, clerk_created_at, clerk_last_sign_in_at, clerk_last_active_at, clerk_email_verified, clerk_phone, clerk_username, clerk_avatar_url, clerk_auth_provider e clerk_external_id. Os valores escalares de public_metadata são gravados como clerk_metadata_<key>.
O clerk_account_status é active, banned quando o Clerk bane o usuário, ou deleted depois do user.deleted. Um banimento ou uma exclusão cancela a inscrição de um contato existente, a menos que ele tenha um clerk_user_id diferente, e nunca cria um contato. A remoção do banimento volta o status para active, mas não inscreve o contato de novo. O user.deleted traz só o ID do usuário, então o Brew usa o endereço de e-mail que viu para esse usuário em um evento anterior do Clerk. Sem esse endereço, o evento é registrado como não resolvido.
Os eventos de convite e de participação preenchem clerk_organization_id, clerk_org_role e clerk_org_role_name, além de clerk_organization_name e clerk_organization_slug quando o evento traz esses dados. O clerk_org_membership_status é invited, active ou removed. Sair de uma organização não cancela a inscrição do contato.
Os eventos de cobrança preenchem clerk_subscription_status com os valores do Stripe, como trialing, active, past_due, canceled e incomplete_expired. O subscriptionItem.canceled mantém o status como active e define clerk_cancel_at_period_end como true, porque o Clerk mantém o plano até o fim do período. Depois, subscriptionItem.ended muda o status para canceled e limpa os campos do plano. Os eventos de cobrança também preenchem clerk_subscription_plan, clerk_subscription_plan_slug, clerk_plan_amount_cents, clerk_plan_interval, clerk_currency, clerk_renews_at e clerk_trial_ends_at quando o evento traz esses dados.
O evento paymentAttempt.created preenche clerk_last_payment_attempt_status, clerk_last_payment_attempt_at e clerk_last_payment_amount_cents. Os campos terminados em _cents usam a menor unidade da moeda, e clerk_currency é um código ISO 4217 em minúsculas, como usd. O waitlistEntry.created preenche clerk_waitlist_status.
Use o esquema de payload declarado do evento selecionado para as tags de mesclagem. Todos os eventos incluem email, firstName, lastName e createdAt. Os demais campos dependem do evento, como planName, planAmount, roleName, organizationName e grandTotalFormatted. Os campos planAmount e grandTotalAmount usam a menor unidade da moeda; em USD, por exemplo, 2000 equivale a US$ 20,00. Os timestamps usam o tempo Unix, em segundos.
Os IDs de objetos do Clerk, como os IDs de usuário, de organização e de assinatura, não são tags de mesclagem. O ID de usuário fica no contato, no campo clerk_user_id.
Uma conta no Clerk não estabelece consentimento para e-mails de marketing. Registre o consentimento no cadastro e confira-o antes de envios promocionais.
Não de forma confiável. O Brew recebe só o paymentAttempt.created, e não as atualizações posteriores da tentativa. O campo status dele pode ter o valor pending, paid ou failed, mas um pagamento que falha depois da criação da tentativa chega ao Brew como um evento não compatível. Para pagamentos em atraso, use o subscriptionItem.pastDue. Para mostrar um total no texto do e-mail, o campo grandTotalFormatted traz um valor já formatado, como $22.00.
Receber um evento e enviar um e-mail são etapas separadas. Confirme que uma automação correspondente está ativa, examine os filtros e o histórico de execuções dela e verifique a elegibilidade do destinatário e o domínio de envio. Uma entrega feita com Send Example verifica o webhook, mas nunca inicia uma automação, e um evento organization.created ou user.deleted sem um endereço de e-mail conhecido é registrado como não resolvido.
Teste grátis de 7 dias. Cartão obrigatório; cancele quando quiser.