E-Mail-Hooks konfigurieren

E-Mail-Benachrichtigungen über Mailto-Hooks konfigurieren: Parameter, Templates und Versionen.

Neben Webhooks bietet der PSB die Möglichkeit, Benachrichtigungen per E-Mail zu versenden. Ein E-Mail-Hook (auch Mailhook oder Mailto-Hook genannt) sendet eine E-Mail für jedes Ereignis zu einem gewählten Topic. Nützlich für Organisationen, die keinen eigenen Webhook-Endpoint haben, oder als Ergänzung zu bestehenden Webhooks.

Einen E-Mail-Hook erstellen

Registrieren Sie einen Hook über die API mit einer mailto:-Action:

{
  "action": "mailto:buchhaltung@Ihr-unternehmen.de",
  "topics": ["InvoiceReceived"]
}

Bei jeder empfangenen Rechnung sendet der PSB nun eine Benachrichtigungs-E-Mail an die angegebene Adresse. Die E-Mail-Adresse in der Action darf auch einen Platzhalter enthalten: [senderEmailAddress] oder [receiverEmailAddress], um dynamisch an die E-Mail-Adresse des Absenders oder Empfängers zu senden.

Wichtig: Verwenden Sie bei Platzhaltern immer den fallbackEmail-Parameter. Wenn die E-Mail-Adresse im Dokument nicht verfügbar ist, sendet der PSB die Benachrichtigung an die Fallback-Adresse.

Parameter

E-Mail-Hooks unterstützen umfangreiche Konfiguration über Queryparameter in der Action-URL. Sie bauen die URL auf als mailto:adresse@domain.de?param1=wert&param2=wert.

ParameterWerteBeschreibungincludeAttachmenttrue / falseFügt das Dokument (XML) als Anhang der E-Mail hinzutargetDocumentTypeIdURN-StringTransformiert den Anhang vor dem Versand in dieses Format (z. B. von NLCIUS nach Factur-X)filenameTemplate-StringDateiname des Anhangs, mit Platzhaltern wie {{id}}{{extension}}. URL-kodieren Sie diesen WertexcludePrimaryAttachmenttrue / falseLässt den XML-Anhang weg (sendet nur den PDF-Anhang)excludeAdditionalAttachmentstrue / falseLässt zusätzliche Anhänge (eingebettete PDF/PNG aus der XML) wegversion0.9 oder 1.0E-Mail-Template-Version (siehe unten)templateIdSendGrid Template IDEigenes E-Mail-Template verwenden (muss von eConnect konfiguriert sein)fallbackEmailE-Mail-AdresseErforderlich bei Verwendung von Platzhaltern in der AdressereplyToE-Mail-AdresseReply-To-Adresse in der E-MailbccKomma-getrennte AdressenBCC-EmpfängerfromE-Mail-AdresseAbsenderadresse überschreiben (nur mit eigenem ApiKey möglich)
Template-Versionen

Der PSB unterstützt zwei Versionen des E-Mail-Templates:

VersionAbsenderadresseHinweis0.9noreply@everbinding.nlAltes Template mit veraltetem Absenderdomäne1.0noreply@econnect.emailNeues eConnect-Template mit modernem Layout

Tipp: Verwenden Sie immer Version 1.0 für neue Konfigurationen. Version 0.9 sendet von der alten eVerbinding-Domäne, die nicht mehr aktiv gepflegt wird.

Vollständiges Beispiel

Ein E-Mail-Hook, der bei jeder empfangenen Rechnung eine E-Mail mit der Rechnung als PDF-Anhang (ohne XML) sendet:

mailto:buchhaltung@Ihr-unternehmen.de?includeAttachment=true&excludePrimaryAttachment=true&version=1.0

Ein Hook, der dynamisch an den Absender sendet, mit Fallback:

mailto:[senderEmailAddress]?includeAttachment=true&version=1.0&fallbackEmail=backup@Ihr-unternehmen.de
Eigenes SendGrid-Template

Möchten Sie die volle Kontrolle über das E-Mail-Layout? Lassen Sie von eConnect ein eigenes SendGrid-Template konfigurieren und verwenden Sie den templateId-Parameter. Sie können auch Ihr eigenes SendGrid-Konto anbinden, indem Sie ein init-Objekt mit Ihrem API-Key zur Hook-Konfiguration hinzufügen.

Mehrere Empfänger

Sie können mehrere E-Mail-Adressen angeben, indem Sie separate Hooks erstellen, oder den bcc-Parameter für zusätzliche Empfänger verwenden.

Häufige Fragen
Warum ist fallbackEmail bei Platzhaltern in der Mailto-Adresse erforderlich?

Platzhalter wie [senderEmailAddress] oder [receiverEmailAddress] werden nur ausgefüllt, wenn die Adresse im Dokument steht. Fehlt sie, sendet der PSB die Benachrichtigung an die Adresse in fallbackEmail, damit Sie keine Nachricht verlieren.

Was ist der Unterschied zwischen Template-Version 0.9 und 1.0?

Version 0.9 verwendet die ältere Absenderdomäne noreply@everbinding.nl; Version 1.0 verwendet noreply@econnect.email mit modernem Layout. Für neue Konfigurationen ist 1.0 die empfohlene Wahl.

Wie sende ich eine Rechnung als Anhang, ohne die primäre XML per E-Mail zu versenden?

Setzen Sie includeAttachment auf true und excludePrimaryAttachment auf true, sodass Sie beispielsweise nur einen PDF-Anhang mitschicken. Kombinieren Sie dies mit version=1.0 in der Query-Zeichenkette für das gewünschte Template.


Die vollständige API-Spezifikation finden Sie unter psb.econnect.eu mit allen möglichen Konfigurationen und Beispielen.

API-Referenz öffnen