Logotipo Hedhog

Receba novidades do Hedhog no seu e-mail

Novos lançamentos, receitas e breaking changes — sem spam.

Documentação do Módulo Campaign

Enterprise

Módulo Enterprise

Campaign faz parte da oferta Enterprise do HedHog e requer uma licença comercial. Apenas o módulo Core é Open Source. Solicitar orçamento →

O módulo Campaign oferece gestão completa de campanhas de e-mail: criar, agendar, enviar e acompanhar campanhas de e-mail com suporte a listas de destinatários, templates reutilizáveis, listas de supressão, descadastros públicos e análise de entrega em tempo real. Ele depende do Core para entrega de e-mail (via Integration Profiles), configurações e notificações, e do Queue para envio assíncrono e com limite de taxa.

Diferente do Core, o Campaign é implementado como um único módulo NestJS com um controller (CampaignController) apoiado por diversos services específicos de cada funcionalidade em libraries/campaign/src/services. Os submódulos abaixo agrupam as rotas desse único controller por área de funcionalidade para fins de documentação — eles não correspondem a módulos NestJS separados, e todo submódulo é conectado incondicionalmente ao CampaignModule.

Submódulos

8

Total de endpoints HTTP

57

campaigns

CRUD principal de campanhas mais ações de ciclo de vida: agendar, iniciar, pausar, retomar, cancelar e duplicar.

18 endpoints

templates

Gerencia templates reutilizáveis de conteúdo de e-mail (nome, assunto, corpo em HTML/texto simples) que as campanhas podem referenciar.

7 endpoints

recipient-lists

Listas nomeadas de destinatários que as campanhas alvejam. Suporta entrada manual, importação por CSV, sincronização com o CRM e cadastro público.

15 endpoints

recipients

CRUD direto sobre registros individuais de campaign_recipient em todas as listas.

6 endpoints

suppression

Lista global de supressão, independente de campanha, que o CampaignDispatchService consulta para pular e-mails aos quais não deve enviar.

5 endpoints

messages

Acesso de leitura aos registros individuais de entrega por destinatário (campaign_message) de uma campanha.

1 endpoint

unsubscribes

Fluxo público de descadastramento baseado em token mais uma listagem administrativa de todos os registros de descadastramento.

3 endpoints

tracking

Endpoints públicos de pixel e redirect para rastreamento de abertura e clique embutidos nos e-mails de campanha enviados.

2 endpoints