E-mail marketing
beehiiv no seu produto e nos seus agentes de IA, por uma API
O toolkit do beehiiv cobre publicações, assinaturas, tags de assinatura, posts e estatísticas agregadas de posts. Seu cliente conecta uma vez com uma API key, e seu produto ou agente de IA chama cada operação pelo Connect, que guarda a credencial e registra cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/beehiiv_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"publicationId": "<publicationId>",
"email": "<email>"
}
}Como funciona
Do cliente conectado à primeira chamada no beehiiv.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do beehiiv. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o beehiiv.
Sincronizar cadastros com a newsletter
Quando um usuário se cadastra no seu SaaS, crie a assinatura na publicação do cliente e aplique uma tag com o plano ou a origem.
Publicar conteúdo pelo seu produto
Crie um post a partir de HTML como rascunho ou agendado, para que uma ferramenta de conteúdo envie newsletters ao beehiiv sem integração própria.
Relatórios de newsletter para agentes
Deixe um agente de IA listar posts e ler estatísticas agregadas, como aberturas, cliques e links mais clicados, para resumir o desempenho da publicação.
Tools
12 tools do beehiiv
- Listar publicaçõesGETLista as publicações que a API key alcança, com id, name e organization_name. expand stats adiciona assinaturas ativas, taxas médias de abertura e clique e totais enviados. Pagine com page e limit, até 100; a resposta traz total_pages.
- Listar assinaturasGETLista as assinaturas (inscritos) de uma publicação, opcionalmente só de um email, status ou tier. Pagine com limit, até 100, e cursor: a resposta traz has_more e next_cursor.
- Obter assinaturaGETRetorna uma assinatura com email, status, created, subscription_tier, os campos utm e referral_code.
- Criar assinaturaPOSTInscreve um email em uma publicação e retorna a assinatura com seu id. Com double opt-in na publicação, ou double_opt_override ativado, a pessoa confirma por email antes de ficar ativa.
- Atualizar assinaturaPATCHAtualiza uma assinatura. Só os campos enviados mudam. unsubscribe true cancela a inscrição da pessoa na publicação.
- Criar tag de assinaturaPOSTAdiciona tags a uma assinatura. Uma tag que ainda não existe na publicação é criada.
- Listar postsGETLista os posts de uma publicação com id, title, subtitle, status, publish_date e web_url. expand stats adiciona as estatísticas de email e web de cada post. Pagine com page e limit, até 100; a resposta traz total_pages.
- Obter postGETRetorna um post; expand stats adiciona suas estatísticas de email e web. Um post criado há pouco pode responder 202 enquanto o beehiiv o monta, e 404 com POST_CREATION_FAILED quando a criação falhou.
- Criar postPOSTCria um post a partir de HTML e retorna seu id; só nos planos Pro e Enterprise. status draft, o padrão, apenas salva; confirmed envia e publica na hora ou em scheduled_at. O beehiiv monta o post em segundo plano, então Get post pode responder 202 por um instante.
- Atualizar postPATCHAtualiza um post; só nos planos Pro e Enterprise. Só os campos enviados mudam, e body_content substitui todo o conteúdo. scheduled_at não pode mudar depois que o post foi enviado.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Perguntas sobre o toolkit do beehiiv
Preciso implementar a API do beehiiv?
Não. O Connect já traz 12 tools do beehiiv descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do beehiiv?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
