Wysyłaj e-maile po zdarzeniach w WorkOS

Połącz WorkOS, aby wysyłać e-maile spójne z marką, gdy użytkownik zostaje utworzony, weryfikuje adres e-mail, resetuje hasło, dołącza do organizacji lub zostaje dodany przez synchronizację katalogów. Brew zamienia 18 typów zdarzeń WorkOS w wyzwalacze automatyzacji.

Za SSO, synchronizację katalogów, logowanie i resety haseł nadal odpowiada WorkOS. Brew tylko nasłuchuje zdarzeń oraz tworzy i wysyła e-maile, które po nich następują.

• E-maile powitalne: WorkOS wysyła zdarzenie user.created, gdy w WorkOS zostanie utworzony użytkownik, a zdarzenie authentication.email_verification_succeeded – gdy użytkownik zweryfikuje adres e-mail. Wybierz jeden wyzwalacz, aby uniknąć podwójnych powitań.
• Potwierdzenia resetu hasła: WorkOS wysyła zdarzenie password_reset.succeeded, gdy reset się zakończy. To zdarzenie WorkOS najwyższego poziomu, a nie część grupy authentication.*.
• Powiadomienia o logowaniu: WorkOS wysyła zdarzenie authentication.magic_auth_succeeded, gdy zakończy się logowanie magicznym linkiem, a authentication.password_failed – gdy nie powiedzie się logowanie hasłem. Odbiorcą obu zdarzeń jest użytkownik, a żadne z nich nie udostępnia adresu IP ani identyfikatora przeglądarki (user agent) jako tagu personalizacji.
• Onboarding zespołu: zdarzenia organization_membership.created i invitation.accepted pojawiają się, gdy ktoś dołącza do organizacji, i oba zawierają pole role. Wybierz jeden wyzwalacz, aby uniknąć podwójnych powitań.
• Powiadomienia o zmianie roli: WorkOS wysyła zdarzenie organization_membership.updated, gdy zmienia się członkostwo, np. rola.
• Użytkownicy z synchronizacji katalogów: zdarzenia dsync.user.created, dsync.user.updated i dsync.user.deleted utrzymują kontakty w Brew w zgodzie z Twoim katalogiem SCIM.
• Powiadomienia przy offboardingu: WorkOS wysyła zdarzenia user.deleted i organization_membership.deleted, gdy użytkownik zostanie usunięty lub opuści organizację.

Zdarzenia organization.created, organization.updated, organization.deleted i connection.activated nie zawierają odbiorcy. Brew zapisuje je w panelu „Ostatnie zdarzenia” jako zdarzenia z nieustalonym odbiorcą i nie uruchamia automatyzacji.

Aby wysłać e-mail do konkretnej osoby w sprawie nowej organizacji, użyj zdarzenia, które zawiera jej adres, np. organization_membership.created lub invitation.accepted.

Zdarzenia członkostwa, uwierzytelniania i katalogów bez adresu e-mail mogą mimo to zostać przetworzone, jeśli Brew zna już z bieżącego połączenia prawdziwy adres e-mail tego samego użytkownika WorkOS, członkostwa lub użytkownika katalogu.

• Otwórz Integracje, wybierz WorkOS i kliknij „Wygeneruj adres URL webhooka”.
• W panelu WorkOS otwórz Webhooks, utwórz endpoint i wklej adres URL Brew.
• Wybierz dla endpointu 18 obsługiwanych zdarzeń: user.*, authentication.email_verification_succeeded, authentication.magic_auth_succeeded, authentication.password_failed, password_reset.succeeded, organization.*, organization_membership.*, dsync.user.*, connection.activated i invitation.accepted. Nie zaznaczaj authentication.*, bo to dodaje zdarzenia uwierzytelniania, których Brew nie obsługuje.
• Skopiuj sekret podpisujący endpointu, wklej go w Brew i kliknij Połącz. Brew weryfikuje każde dostarczenie na podstawie nagłówka podpisu WorkOS, z tolerancją znacznika czasu wynoszącą 180 sekund.
• W WorkOS wyślij z endpointu testowe zdarzenie user.created. Status w Brew zmieni się z „Czeka na zdarzenie testowe” na „Połączona”. Brew pomija przykładowe zdarzenia WorkOS, które rozpoznaje, ale nierozpoznany przykład może przetworzyć jak prawdziwe zdarzenie, więc wyślij test, zanim opublikujesz automatyzację z tym wyzwalaczem.
• Kliknięcie Połącz tworzy wyzwalacze dla wszystkich 18 zdarzeń. Nie ma przełącznika do włączania lub wyłączania zdarzeń.
• Utwórz automatyzację, wybierz dla niej zdarzenie WorkOS i wyślij test, dopóki jest jeszcze wersją roboczą. Po nadejściu pasującego zdarzenia uruchamiają się tylko aktywne automatyzacje.

Brew obsługuje 18 typów zdarzeń:

• user.created
• user.updated
• user.deleted
• authentication.email_verification_succeeded
• authentication.password_failed
• password_reset.succeeded
• authentication.magic_auth_succeeded
• organization.created
• organization.updated
• organization.deleted
• organization_membership.created
• organization_membership.updated
• organization_membership.deleted
• dsync.user.created
• dsync.user.updated
• dsync.user.deleted
• connection.activated
• invitation.accepted

Każde zweryfikowane zdarzenie z prawdziwym adresem e-mail tworzy lub aktualizuje kontakt w Brew dopasowany po adresie e-mail – niezależnie od tego, czy jakaś automatyzacja korzysta z tego zdarzenia. Jeśli zdarzenie zawiera odpowiednie dane, Brew ustawia imię, nazwisko oraz pola workos_user_id i workos_email_verified.

Zdarzenia uwierzytelniania ustawiają pole workos_last_verification_at, workos_last_failed_auth_at, workos_last_password_reset_at lub workos_last_magic_auth_at. Zdarzenia członkostwa i zaproszeń ustawiają pola workos_organization_id i workos_org_role. Zdarzenia katalogów ustawiają pola workos_directory_user_id i workos_directory_id.

Zdarzenia user.deleted i dsync.user.deleted ustawiają pole workos_account_status na deleted, a organization_membership.deleted – na removed_from_org. Brew nie usuwa kontaktu.

W tagach personalizacji korzystaj ze schematu danych zadeklarowanego dla wybranego zdarzenia. Każde zdarzenie zawiera pola email, firstName, lastName i createdAt, jeśli są dostępne. Zdarzenia użytkowników dodają pole emailVerified, zdarzenia organizacji – pole organizationName, a zdarzenia członkostwa i zaproszeń – pole role. Pole createdAt to znacznik czasu uniksowego w sekundach.

Identyfikatory obiektów WorkOS nie są tagami personalizacji – podobnie jak adres IP i identyfikator przeglądarki (user agent) w zdarzeniach uwierzytelniania.

Pracownicy synchronizowani z katalogu zwykle nie wyrazili zgody na komunikację marketingową. Traktuj ich jako odbiorców powiadomień o koncie i wiadomości transakcyjnych, chyba że osobno wyrazili taką zgodę.

Odebranie zdarzenia i wysłanie e-maila to osobne kroki. Upewnij się, że pasująca automatyzacja jest aktywna, a potem przejrzyj jej filtry i historię uruchomień, sprawdź, czy odbiorca może otrzymać wiadomość, i skontroluj domenę wysyłkową. Zdarzenia organizacji i połączeń nigdy nie uruchamiają automatyzacji, a rozpoznane przykładowe zdarzenie z WorkOS jest zapisywane jako zdarzenie testowe.

• Brew nie może tworzyć ani zmieniać w WorkOS użytkowników, organizacji, katalogów ani połączeń.
• Błąd 401 z kodem timestamp_invalid:out_of_tolerance oznacza, że znacznik czasu dostarczenia różnił się o ponad 180 sekund. Sprawdź rozbieżność zegarów, a potem ponów dostarczenie z panelu WorkOS.
• Jeśli automatyzacje po resecie hasła nigdy się nie uruchamiają, sprawdź, czy wybrano dla endpointu zdarzenie password_reset.succeeded. WorkOS nigdy nie wysyła zdarzenia authentication.password_reset_succeeded.
• Jeśli żadne dostarczenie nie przechodzi weryfikacji podpisu, skopiuj aktualny sekret endpointu z WorkOS i połącz WorkOS ponownie. Brew wymaga, aby sekret miał co najmniej 16 znaków.
• Sprawdź zgody i cel każdego e-maila. Synchronizacja użytkowników WorkOS nie upoważnia do wysyłek promocyjnych.

• Instrukcja konfiguracji WorkOS
• Zbuduj automatyzację
• Tagi personalizacji
• Co możesz wysyłać przez Brew
• Zdarzenia WorkOS