Suscripciones por correo electrónico
Conecta Resend, Mailchimp, Kit, Loops, beehiiv, Brevo o SendGrid para recopilar suscripciones desde tu documentación directamente en tu proveedor.
Jamdesk puede recopilar direcciones de correo electrónico desde tu sitio de documentación y añadirlas directamente al proveedor de correo que ya utilizas. No interviene ningún servicio de formularios de terceros. Conecta un proveedor una sola vez en el dashboard, luego coloca un formulario de suscripción en cualquier página. La lista es tuya y el envío es tuyo; Jamdesk solo captura la dirección y la entrega a tu proveedor.
Requisitos previos
- Una cuenta con uno de los proveedores compatibles
- Una API key de ese proveedor con permiso para añadir contactos
- El identificador de audiencia que la mayoría de proveedores usan para elegir una lista (Audience ID, List ID, Form ID o Publication ID)
Cómo funciona la captura
Al conectar un proveedor, Jamdesk valida la API key contra la API de ese proveedor antes de guardarla. A partir de entonces, cada envío de formulario en tu sitio de documentación llama al proveedor y añade al lector a tu audiencia. Los envíos están limitados por visitante y por proyecto para evitar abusos, y un campo honeypot oculto filtra los bots.
Tu API key se almacena en el backend de Jamdesk y se usa únicamente para añadir contactos. Nunca se escribe en tu sitio publicado, en tu docs.json ni en ningún código del lado del cliente, por lo que los visitantes no pueden leerla.
Proveedores compatibles
Siete proveedores capturan suscripciones de forma nativa. Los lectores envían un formulario alojado en Jamdesk y llegan a tu audiencia sin salir de tu documentación:
| Proveedor | Qué conectas |
|---|---|
| Resend | API key (acceso completo) + Audience ID |
| Mailchimp | API key (termina en tu datacenter, p. ej. -us21) + Audience (List) ID |
| Kit (ConvertKit) | API key v4 + Form ID |
| Loops | API key |
| beehiiv | API key + Publication ID |
| Brevo | API key v3 + Contact List ID |
| SendGrid | API key con acceso de escritura a Marketing Contacts + Marketing List ID |
Dos proveedores más son solo de incrustación. Jamdesk renderiza su propio formulario o iframe en lugar de capturar la dirección, por lo que no se necesita ninguna clave:
| Proveedor | Qué proporcionas |
|---|---|
| Buttondown | Tu username de cuenta (en la etiqueta <EmailSubscribe>) |
| Substack | Tu username de cuenta (en la etiqueta <EmailSubscribe>) |
Consulta EmailSubscribe para la configuración de solo incrustación.
Conectar un proveedor
En el dashboard, abre tu proyecto y ve a Settings. Busca la tarjeta Email Signups.
Selecciona un proveedor en el desplegable Provider. El formulario se actualiza para solicitar exactamente los campos que ese proveedor necesita, con un enlace a dónde encontrar su API key.
Introduce la API key y, para la mayoría de proveedores, el identificador de audiencia (Loops solo necesita la clave). El campo de clave está enmascarado.
Haz clic en Connect. Jamdesk valida la clave con tu proveedor antes de guardarla. Si la clave es incorrecta o no tiene permisos de contacto, verás un error y no se guarda nada.
Una vez conectado, la tarjeta muestra una insignia Configured con tu proveedor y audience ID. Las nuevas publicaciones de tu documentación renderizan formularios de captura en vivo.
Personalizar el texto del formulario
La tarjeta tiene dos campos opcionales, Form title y Form subtitle, que establecen el encabezado y la línea de apoyo en los formularios colocados automáticamente. Déjalos en blanco y el formulario muestra solo el campo y el botón; rellénalos y los formularios de changelog los recogerán en la próxima publicación — sin necesidad de editar docs.json.
Puedes cambiar este texto en cualquier momento. Edita los campos en una tarjeta conectada y haz clic en Save copy; no necesitas volver a introducir tu API key. Un title o description definido directamente en docs.json o en una etiqueta <EmailSubscribe> tiene prioridad sobre el texto del dashboard, por lo que las personalizaciones por página siguen funcionando.
Añadir un formulario a tu documentación
Conectar un proveedor no coloca un formulario por sí solo. Tú eliges dónde aparecen las suscripciones:
- Escribe
<EmailSubscribe provider="resend" />(usando el id de tu proveedor conectado) en cualquier página. - O coloca automáticamente un formulario en cada página de changelog configurando
placement: changelogendocs.json.
Ambas opciones están documentadas en la página del componente EmailSubscribe.
Desconectar un proveedor
Para dejar de recopilar suscripciones, abre la tarjeta Email Signups y haz clic en Remove. Los formularios dejan de capturar en tu próxima publicación.
Desconectar elimina la clave de Jamdesk únicamente. Los suscriptores que ya recopilaste permanecen en la audiencia de tu proveedor — Jamdesk nunca los elimina. Puedes reconectar en cualquier momento.