Configurar e-mail hooks en la PSB

Además de los webhooks, la PSB ofrece la posibilidad de enviar notificaciones por correo electrónico. Un e-mail hook (también llamado mailhook o mailto-hook) envía un correo electrónico con cada evento en un topic elegido. Resulta útil para organizaciones que no disponen de un endpoint webhook propio, o como complemento de webhooks existentes.

Crear un e-mail hook

Registre un hook a través de la API con una acción mailto::

{
  "action": "mailto:[email protected]",
  "topics": ["InvoiceReceived"]
}

Con cada factura recibida, la PSB envía ahora un correo electrónico de notificación a la dirección indicada. La dirección de correo electrónico en la acción también puede contener un placeholder: [senderEmailAddress] o [receiverEmailAddress] para enviar dinámicamente a la dirección de correo del remitente o del destinatario.

Atención: Al utilizar placeholders, especifique siempre el parámetro fallbackEmail. Si la dirección de correo electrónico no está disponible en el documento, la PSB envía la notificación a la dirección de respaldo.

Parámetros

Los e-mail hooks admiten una configuración amplia mediante parámetros de consulta en la URL de la acción. Construya la URL de la siguiente forma: mailto:[email protected]?param1=waarde&param2=waarde.

Parámetro

Valores

Descripción

includeAttachment

true / false

Adjunta el documento (XML) al correo electrónico

targetDocumentTypeId

cadena URN

Transforma el adjunto a este formato antes del envío (por ejemplo de NLCIUS a Factur-X)

filename

cadena de plantilla

Nombre de archivo del adjunto, con placeholders como {{id}}{{extension}}. Codifique este valor en URL

excludePrimaryAttachment

true / false

Omite el adjunto XML (solo envía el adjunto PDF)

excludeAdditionalAttachments

true / false

Omite los adjuntos adicionales (PDF/PNG incrustados en el XML)

version

0.9 o 1.0

Versión de la plantilla de correo electrónico (ver más abajo)

templateId

ID de plantilla SendGrid

Utiliza una plantilla de correo personalizada (debe ser configurada por eConnect)

fallbackEmail

dirección de correo

Obligatorio al utilizar placeholders en la dirección

replyTo

dirección de correo

Dirección reply-to en el correo electrónico

bcc

direcciones separadas por comas

Destinatarios en copia oculta

from

dirección de correo

Sustituir la dirección del remitente (solo posible con su propia ApiKey)

Versiones de plantilla

La PSB admite dos versiones de la plantilla de correo electrónico:

Versión

Dirección del remitente

Explicación

0.9

[email protected]

Plantilla antigua con un dominio de remitente obsoleto

1.0

[email protected]

Nueva plantilla eConnect con diseño moderno

Consejo: Utilice siempre la versión 1.0 para nuevas configuraciones. La versión 0.9 envía desde el antiguo dominio eVerbinding, que ya no se mantiene activamente.

Ejemplo completo

Un e-mail hook que envía un correo electrónico con cada factura recibida, con la factura como adjunto PDF, sin el XML:

mailto:[email protected]?includeAttachment=true&excludePrimaryAttachment=true&version=1.0

Un hook que envía dinámicamente al remitente, con un fallback:

mailto:[senderEmailAddress]?includeAttachment=true&version=1.0&[email protected]

Plantilla SendGrid personalizada

¿Desea un control total sobre el diseño del correo electrónico? Solicite a eConnect que configure una plantilla SendGrid personalizada y utilice el parámetro templateId. También puede conectar su propia cuenta SendGrid añadiendo un objeto init con su clave API a la configuración del hook.

Múltiples destinatarios

Puede especificar múltiples direcciones de correo electrónico creando hooks separados, o utilizando el parámetro bcc para destinatarios adicionales.

Preguntas frecuentes

¿Por qué es obligatorio fallbackEmail con placeholders en la dirección mailto?

Placeholders como [senderEmailAddress] o [receiverEmailAddress] solo se rellenan si la dirección figura en el documento. Si falta, la PSB envía la notificación a la dirección en fallbackEmail, para que no pierda el mensaje.

¿Cuál es la diferencia entre la versión de plantilla 0.9 y 1.0?

La versión 0.9 usa el dominio de remitente anterior [email protected]; la versión 1.0 usa [email protected] con diseño moderno. Para nuevas configuraciones se recomienda 1.0.

¿Cómo envío una factura como adjunto sin enviar la XML primaria por correo?

Establezca includeAttachment en true y excludePrimaryAttachment en true, por ejemplo para enviar solo un adjunto PDF. Combínelo con version=1.0 en la cadena de consulta para la plantilla deseada.

Consulte la especificación API completa en psb.econnect.eu para todas las configuraciones y ejemplos posibles.

Abrir la referencia API