Konfigurácia e-mail hookov v PSB

Okrem webhookov ponúka PSB možnosť odosielať notifikácie e-mailom. E-mail hook (tiež mailhook alebo mailto hook) odošle e-mail pri každej udalosti na zvolenom topiku. Je to praktické pre organizácie, ktoré nemajú vlastný webhook endpoint, alebo ako doplnok k existujúcim webhookom.

Vytvorenie e-mail hooku

Zaregistrujte hook cez API s akciou mailto::

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

Pri každej prijatej faktúre PSB teraz odošle notifikačný e-mail na zadanú adresu. E-mailová adresa v akcii môže obsahovať aj placeholder: [senderEmailAddress] alebo [receiverEmailAddress] na dynamické odosielanie na e-mailovú adresu odosielateľa alebo príjemcu.

Pozor: Pri placeholderoch vždy použite parameter fallbackEmail. Ak e-mailová adresa nie je v dokumente k dispozícii, PSB odošle notifikáciu na fallback adresu.

Parametre

E-mail hooky podporujú rozšírenú konfiguráciu cez parametre dotazu v action URL. URL zostavíte ako mailto:adresa@domena.sk?param1=hodnota&param2=hodnota.

Parameter

Hodnoty

Popis

includeAttachment

true / false

Pridá dokument (XML) ako prílohu k e-mailu

targetDocumentTypeId

URN reťazec

Transformuje prílohu do tohto formátu pred odoslaním (napríklad z NLCIUS na Factur-X)

filename

šablónový reťazec

Názov súboru prílohy s placeholdermi ako {{id}}{{extension}}. URL-enkódujte túto hodnotu

excludePrimaryAttachment

true / false

Vynechá XML prílohu (odošle len PDF prílohu)

excludeAdditionalAttachments

true / false

Vynechá ďalšie prílohy (vložené PDF/PNG z XML)

version

0.9 alebo 1.0

Verzia e-mailovej šablóny (pozri nižšie)

templateId

SendGrid template ID

Použitie vlastnej e-mailovej šablóny (musí byť nakonfigurované spoločnosťou eConnect)

fallbackEmail

e-mailová adresa

Povinné pri použití placeholderov v adrese

replyTo

e-mailová adresa

Reply-to adresa v e-maile

bcc

adresy oddelené čiarkou

BCC príjemcovia

from

e-mailová adresa

Prepísanie adresy odosielateľa (možné len s vlastným ApiKey)

Verzie šablón

PSB podporuje dve verzie e-mailovej šablóny:

Verzia

Adresa odosielateľa

Vysvetlenie

0.9

noreply@everbinding.nl

Stará šablóna so zastaranou doménou odosielateľa

1.0

noreply@econnect.email

Nová eConnect šablóna s moderným formátovaním

Tip: Pre nové konfigurácie používajte vždy verziu 1.0. Verzia 0.9 odosiela zo starej domény eVerbinding, ktorá sa už aktívne neudržiava.

Kompletný príklad

E-mail hook, ktorý pri každej prijatej faktúre odošle e-mail s faktúrou ako PDF prílohou, bez XML:

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

Hook, ktorý dynamicky odosiela odosielateľovi, s fallbackom:

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

Vlastná SendGrid šablóna

Chcete plnú kontrolu nad formátovaním e-mailu? Nechajte si od eConnectu nakonfigurovať vlastnú SendGrid šablónu a použite parameter templateId. Môžete tiež prepojiť vlastný SendGrid účet pridaním objektu init s Vaším API kľúčom do konfigurácie hooku.

Viacerí príjemcovia

Môžete zadať viacero e-mailových adries vytvorením samostatných hookov, alebo použitím parametra bcc pre ďalších príjemcov.

Často kladené otázky

Prečo je fallbackEmail povinný pri placeholderoch v mailto adrese?

Placeholdery ako [senderEmailAddress] alebo [receiverEmailAddress] sa vyplnia len vtedy, ak je adresa v dokumente. Ak chýba, PSB odošle notifikáciu na adresu v fallbackEmail, aby ste neprišli o správu.

Čo je rozdiel medzi verziou šablóny 0.9 a 1.0?

Verzia 0.9 používa staršiu doménu odosielateľa noreply@everbinding.nl; verzia 1.0 používa noreply@econnect.email s moderným rozvrhnutím. Pre nové konfigurácie sa odporúča 1.0.

Ako poslať faktúru ako prílohu bez odoslania primárneho XML e-mailom?

Nastavte includeAttachment na true a excludePrimaryAttachment na true, aby ste napríklad poslali len PDF prílohu. Skombinujte to s version=1.0 v query reťazci pre požadovanú šablónu.

Kompletnú API špecifikáciu nájdete na psb.econnect.eu so všetkými možnosťami konfigurácie a príkladmi.

Otvoriť API referenciu