Konfiguracja e-mail hooków w PSB

Oprócz webhooków PSB oferuje możliwość wysyłania powiadomień e-mail. E-mail hook (nazywany również mailhook lub mailto hook) wysyła e-mail przy każdym zdarzeniu na wybranym topiku. Przydatne dla organizacji, które nie mają własnego endpointu webhookowego, lub jako uzupełnienie istniejących webhooków.

Tworzenie e-mail hooka

Rejestracja hooka przez API z akcją mailto::

{
  "action": "mailto:finance@jouw-bedrijf.nl",
  "topics": ["InvoiceReceived"]
}

Przy każdej otrzymanej fakturze PSB wyśle e-mail z powiadomieniem na podany adres. Adres e-mail w akcji może również zawierać placeholder: [senderEmailAddress] lub [receiverEmailAddress] do dynamicznego wysyłania na adres e-mail nadawcy lub odbiorcy.

Uwaga: Przy użyciu placeholderów zawsze należy stosować parametr fallbackEmail. Jeśli adres e-mail nie jest dostępny w dokumencie, PSB wyśle powiadomienie na adres zapasowy.

Parametry

E-mail hooki obsługują rozbudowaną konfigurację przez parametry query w URL akcji. URL buduje się jako mailto:adres@domena.nl?param1=wartość&param2=wartość.

Parametr

Wartości

Opis

includeAttachment

true / false

Dodaje dokument (XML) jako załącznik do e-maila

targetDocumentTypeId

Ciąg URN

Transformuje załącznik do tego formatu przed wysłaniem (np. z NLCIUS na Factur-X)

filename

Ciąg szablonowy

Nazwa pliku załącznika, z placeholderami jak {{id}}{{extension}}. Należy zakodować tę wartość w URL

excludePrimaryAttachment

true / false

Pomija załącznik XML (wysyła tylko załącznik PDF)

excludeAdditionalAttachments

true / false

Pomija dodatkowe załączniki (osadzone PDF/PNG z XML)

version

0.9 lub 1.0

Wersja szablonu e-mail (patrz poniżej)

templateId

ID szablonu SendGrid

Używa własnego szablonu e-mail (musi być skonfigurowany przez eConnect)

fallbackEmail

Adres e-mail

Wymagany przy użyciu placeholderów w adresie

replyTo

Adres e-mail

Adres reply-to w e-mailu

bcc

Adresy oddzielone przecinkami

Odbiorcy BCC

from

Adres e-mail

Nadpisanie adresu nadawcy (możliwe tylko z własnym ApiKey)

Wersje szablonów

PSB obsługuje dwie wersje szablonu e-mail:

Wersja

Adres nadawcy

Uwagi

0.9

noreply@everbinding.nl

Stary szablon z przestarzałą domeną nadawcy

1.0

noreply@econnect.email

Nowy szablon eConnect z nowoczesnym layoutem

Wskazówka: Zawsze należy używać wersji 1.0 dla nowych konfiguracji. Wersja 0.9 wysyła ze starej domeny eVerbinding, która nie jest już aktywnie utrzymywana.

Pełny przykład

E-mail hook, który przy każdej otrzymanej fakturze wysyła e-mail z fakturą jako załącznik PDF, bez XML:

mailto:finance@jouw-bedrijf.nl?includeAttachment=true&excludePrimaryAttachment=true&version=1.0

Hook, który dynamicznie wysyła do nadawcy, z fallbackiem:

mailto:[senderEmailAddress]?includeAttachment=true&version=1.0&fallbackEmail=backup@jouw-bedrijf.nl

Własny szablon SendGrid

Chcą Państwo mieć pełną kontrolę nad wyglądem e-maila? Należy zlecić eConnect skonfigurowanie własnego szablonu SendGrid i użyć parametru templateId. Można też podłączyć własne konto SendGrid, dodając obiekt init z kluczem API do konfiguracji hooka.

Wielu odbiorców

Można podać wiele adresów e-mail, tworząc osobne hooki, lub korzystając z parametru bcc dla dodatkowych odbiorców.

Często zadawane pytania

Dlaczego przy placeholderach w adresie mailto wymagany jest fallbackEmail?

Placeholdery takie jak [senderEmailAddress] lub [receiverEmailAddress] są uzupełniane tylko wtedy, gdy adres znajduje się w dokumencie. Jeśli go brakuje, PSB wysyła powiadomienie na adres w fallbackEmail, aby Państwo nie tracili wiadomości.

Jaka jest różnica między wersją szablonu 0.9 a 1.0?

Wersja 0.9 korzysta ze starszej domeny nadawcy noreply@everbinding.nl; wersja 1.0 używa noreply@econnect.email z nowoczesnym układem. W nowych konfiguracjach zalecana jest 1.0.

Jak wysłać fakturę jako załącznik bez e-mailowania pierwotnego XML?

Należy ustawić includeAttachment na true i excludePrimaryAttachment na true, aby na przykład wysłać tylko załącznik PDF. Należy to połączyć z version=1.0 w query string dla wybranego szablonu.

Pełna specyfikacja API dostępna jest na psb.econnect.eu ze wszystkimi możliwymi konfiguracjami i przykładami.

Otwórz referencję API