Konfigurace e-mail hooků v PSB

Kromě webhooků nabízí PSB možnost odesílat notifikace e-mailem. E-mail hook (také mailhook nebo mailto hook) odešle e-mail při každé události na zvoleném topiku. Je to praktické pro organizace, které nemají vlastní webhook endpoint, nebo jako doplněk k existujícím webhookům.

Vytvoření e-mail hooku

Zaregistrujte hook přes API s akcí mailto::

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

Při každé přijaté faktuře PSB nyní odešle notifikační e-mail na zadanou adresu. E-mailová adresa v akci může obsahovat i placeholder: [senderEmailAddress] nebo [receiverEmailAddress] pro dynamické odesílání na e-mailovou adresu odesílatele nebo příjemce.

Pozor: Při placeholderech vždy použijte parametr fallbackEmail. Pokud e-mailová adresa není v dokumentu k dispozici, PSB odešle notifikaci na fallback adresu.

Parametry

E-mail hooky podporují rozšířenou konfiguraci přes parametry dotazu v action URL. URL sestavíte jako mailto:adresa@domena.cz?param1=hodnota&param2=hodnota.

Parametr

Hodnoty

Popis

includeAttachment

true / false

Přidá dokument (XML) jako přílohu k e-mailu

targetDocumentTypeId

URN řetězec

Transformuje přílohu do tohoto formátu před odesláním (například z NLCIUS na Factur-X)

filename

šablonový řetězec

Název souboru přílohy s placeholdery jako {{id}}{{extension}}. URL-enkódujte tuto hodnotu

excludePrimaryAttachment

true / false

Vynechá XML přílohu (odešle jen PDF přílohu)

excludeAdditionalAttachments

true / false

Vynechá další přílohy (vložené PDF/PNG z XML)

version

0.9 nebo 1.0

Verze e-mailové šablony (viz níže)

templateId

SendGrid template ID

Použití vlastní e-mailové šablony (musí být nakonfigurováno společností eConnect)

fallbackEmail

e-mailová adresa

Povinné při použití placeholderů v adrese

replyTo

e-mailová adresa

Reply-to adresa v e-mailu

bcc

adresy oddělené čárkou

BCC příjemci

from

e-mailová adresa

Přepsání adresy odesílatele (možné jen s vlastním ApiKey)

Verze šablon

PSB podporuje dvě verze e-mailové šablony:

Verze

Adresa odesílatele

Vysvětlení

0.9

noreply@everbinding.nl

Stará šablona se zastaralou doménou odesílatele

1.0

noreply@econnect.email

Nová eConnect šablona s moderním formátováním

Tip: Pro nové konfigurace používejte vždy verzi 1.0. Verze 0.9 odesílá ze staré domény eVerbinding, která se již aktivně neudržuje.

Kompletní příklad

E-mail hook, který při každé přijaté faktuře odešle e-mail s fakturou jako PDF přílohou, bez XML:

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

Hook, který dynamicky odesílá odesílateli, s fallbackem:

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

Vlastní SendGrid šablona

Chcete plnou kontrolu nad formátováním e-mailu? Nechte si od eConnectu nakonfigurovat vlastní SendGrid šablonu a použijte parametr templateId. Můžete také propojit vlastní SendGrid účet přidáním objektu init s Vaším API klíčem do konfigurace hooku.

Více příjemců

Můžete zadat více e-mailových adres vytvořením samostatných hooků, nebo použitím parametru bcc pro další příjemce.

Často kladené otázky

Proč je fallbackEmail povinný u placeholderů v mailto adrese?

Placeholdery jako [senderEmailAddress] nebo [receiverEmailAddress] se vyplní jen tehdy, pokud je adresa v dokumentu. Chybí-li, PSB odešle notifikaci na adresu v fallbackEmail, abyste neztratili zprávu.

Jaký je rozdíl mezi verzí šablony 0.9 a 1.0?

Verze 0.9 používá starší doménu odesílatele noreply@everbinding.nl; verze 1.0 používá noreply@econnect.email s moderním rozvržením. Pro nové konfigurace se doporučuje 1.0.

Jak odeslat fakturu jako přílohu bez odeslání primárního XML e-mailem?

Nastavte includeAttachment na true a excludePrimaryAttachment na true, abyste například poslali jen PDF přílohu. Kombinujte to s version=1.0 v query řetězci pro požadovanou šablonu.

Kompletní API specifikaci naleznete na psb.econnect.eu se všemi možnostmi konfigurace a příklady.

Otevřít API referenci