Inscrições por e-mail
Conecte Resend, Mailchimp, Kit, Loops, beehiiv, Brevo ou SendGrid para captar e enviar inscrições por e-mail da documentação à audiência do provedor.
O Jamdesk coleta endereços de e-mail no seu site de documentação e os adiciona ao provedor de e-mail que você já usa. Não há nenhum serviço de formulários de terceiros entre vocês. Conecte um provedor uma vez no dashboard. Depois, adicione um formulário de inscrição a qualquer página. Você controla a lista e o envio. O Jamdesk captura o endereço e o repassa ao seu provedor.
As capturas de tela mostram a interface em inglês.
Pré-requisitos
- Uma conta em um dos provedores compatíveis
- Uma chave de API desse provedor com permissão para adicionar contatos
- O identificador de audiência usado pela maioria dos provedores para selecionar uma lista (Audience ID, List ID, Form ID ou Publication ID)
Como a captura funciona
O Jamdesk valida a chave de API com a API do provedor antes de salvá-la. Cada envio de formulário no seu site de documentação chama o provedor e adiciona o leitor à sua audiência. Os envios têm limite de frequência por visitante e por projeto. Um campo honeypot oculto filtra bots.
Os leitores veem um formulário como este:

Você pode ver um exemplo ao vivo no changelog do Jamdesk.
Sua chave de API fica armazenada no backend do Jamdesk e é usada apenas para adicionar contatos. Ela nunca é incluída no site publicado, no seu docs.json ou em qualquer código do lado do cliente.
Provedores compatíveis
Sete provedores capturam inscrições nativamente. Os leitores enviam um formulário hospedado pelo Jamdesk e entram na sua audiência sem sair da documentação:
| Provedor | O que conectar |
|---|---|
| Resend | Chave de API (acesso total) + Audience ID |
| Mailchimp | Chave de API (termina com o datacenter, por exemplo, -us21) + Audience (List) ID |
| Kit (ConvertKit) | Chave de API v4 + Form ID |
| Loops | Chave de API |
| beehiiv | Chave de API + Publication ID |
| Brevo | Chave de API v3 + Contact List ID |
| SendGrid | Chave de API com acesso de gravação a Marketing Contacts + Marketing List ID |
Dois outros provedores permitem somente incorporação. O Jamdesk exibe o próprio formulário ou iframe deles em vez de capturar o endereço. Não é necessária uma chave:
| Provedor | O que você fornece |
|---|---|
| Buttondown | O username da sua conta (na tag <EmailSubscribe>) |
| Substack | O username da sua conta (na tag <EmailSubscribe>) |
Consulte EmailSubscribe para ver a configuração de incorporação.
Conectar um provedor
No dashboard, abra seu projeto e acesse Integrations. Encontre o cartão Email Signups.
Escolha um provedor no menu suspenso Provider. O formulário solicitará os campos necessários para esse provedor e incluirá um link para encontrar a chave de API.
Insira a chave de API e, para a maioria dos provedores, o identificador da audiência (o Loops requer apenas a chave). O campo da chave é mascarado.
Clique em Connect. O Jamdesk valida a chave com seu provedor antes de salvá-la. Uma chave incorreta ou sem permissões para gerenciar contatos gera um erro. Nada é armazenado.
O cartão conectado exibe o selo Configured com o nome do provedor e o ID da audiência. As próximas publicações da documentação exibirão formulários de captura ativos.
Personalizar o texto do formulário
Os campos opcionais Form title e Form subtitle definem o título e a frase de apoio dos formulários inseridos automaticamente. Se os campos ficarem em branco, o formulário exibirá apenas o campo de e-mail e o botão. Os formulários do changelog usarão os campos preenchidos na próxima publicação, sem precisar editar docs.json.
Altere esse texto quando quiser. Edite os campos em um cartão conectado e clique em Save copy. Não é necessário inserir a chave de API novamente. Um title ou description definido em docs.json ou em uma tag <EmailSubscribe> substitui o texto configurado no dashboard.
Adicionar um formulário à documentação
Conectar um provedor não insere um formulário automaticamente. Você escolhe onde as inscrições aparecem:
- Adicione
<EmailSubscribe provider="resend" />a qualquer página, usando o ID do provedor conectado. - Ou defina
placement: changelogemdocs.jsonpara inserir automaticamente um formulário em cada página do changelog.
A página do componente EmailSubscribe explica essas opções.
Desconectar um provedor
Abra o cartão Email Signups e clique em Remove para parar de coletar inscrições. Os formulários deixarão de capturá-las após a próxima publicação.
Desconectar remove a chave apenas do Jamdesk. Os inscritos que você já coletou permanecem na audiência do seu provedor. O Jamdesk nunca os exclui. Você pode conectar o provedor novamente quando quiser.
