Pular para o conteúdo principal

Formulários e ações

Dois blocos do Construtor deixam o cliente fazer algo no portal: o Formulário, que envia o que ele preencheu por e-mail ou para um webhook, e o Botão de ação, que abre um link ou dispara um webhook.

Na página Ajuda da Aurora Energia, o formulário Fale com a gente envia a mensagem do cliente para atendimento@auroraenergia.com.br, e o botão Pedir religação abre o site da empresa numa nova aba.

Perguntas frequentes e formulário de contato

Formulário​

Campos​

Em Campos, adicione um item para cada campo do formulário:

PropriedadePara que serve
RótuloO nome do campo para o cliente, como Unidade consumidora.
Nome da variávelComo o valor é usado no e-mail ou no webhook ({{unidade}}). Vazio, é criado a partir do rótulo.
TipoO formato aceito (veja abaixo).
Valor inicialO que o campo já traz preenchido. Aceita expressões, como {{ $user.email }}.
ObrigatórioSe o cliente precisa preencher.

Os tipos validam e formatam o que o cliente digita:

TipoAceita
Texto, Texto longoQualquer texto
E-mailUm e-mail válido
Telefone(00) 0000-0000 ou celular com 9 dígitos
URLhttp:// ou https://
NúmerosSó números
Moeda Reais / Moeda OutrasValores como R$ 999.999,99
CPF, CNPJ, CPF ou CNPJDocumentos válidos, com a máscara aplicada
RegexpO texto que casar com a Expressão regular que você informar, como [A-Z]{3}-\d{4}

Valores iniciais​

Para poupar o cliente de digitar o que o portal já sabe, use no Valor inicial:

ExpressãoValor
{{ $user.name }}Nome de quem está logado
{{ $user.first_name }}Primeiro nome
{{ $user.email }}E-mail
{{ $user.id }}Id do usuário do portal
{{ $tenant.id }}Tenant ID do usuário

Dá para combinar com texto e métodos, como {{ $user.name.toUpperCase() }}. No Construtor, o valor aparece com os dados do usuário escolhido em Ver como.

No formulário de pedido de vistoria da Aurora Imóveis, o Nome começa com {{ $user.name }}, e CPF e Telefone são obrigatórios, nos tipos CPF e Telefone.

O que acontece no envio​

Em Ação ao enviar, escolha:

E-mail

CampoPara que serve
ParaOs destinatários, separados por vírgula (até 10).
AssuntoO assunto do e-mail.
MensagemO corpo do e-mail.

Nos três campos você pode usar {{variáveis}}: as de cada campo do formulário e as do envio — {{form_title}}, {{page_path}}, {{submitted_at}}, {{customer_name}}, {{customer_email}}, {{organization_name}} e {{all_fields}} (todos os campos, um por linha). Clique numa variável na lista do painel para copiá-la. Também valem expressões como {{ $now.toFormat('dd/MM/yyyy') }}.

O e-mail sai com o remetente, o endereço de resposta, a cópia oculta e o layout definidos em Notificações, e fica no histórico de notificações.

Webhook

Escolha um dos webhooks ativos do workspace, cadastrados em API e webhooks › Webhooks. O envio segue pela mesma fila dos outros webhooks — com a mesma assinatura, novas tentativas e o registro em Entregas. Nenhuma URL ou credencial fica na página.

Defina também o Texto do botão e a Mensagem de sucesso, que o cliente vê depois de enviar.

Botão de ação​

PropriedadePara que serve
Texto do botãoO que aparece no botão.
TipoLink ou Webhook.
EstiloCheio ou Contorno.
Ícone e Posição do íconeUm ícone antes ou depois do texto.
AlinhamentoEsquerda, centro ou direita.
Pedir confirmaçãoMostra a Mensagem de confirmação antes de seguir.

Em Abrir, escolha Página do portal (e a página) ou URL — um endereço https://…, mailto: ou tel:, com a opção Abrir em nova aba. Um link só leva o cliente a outro lugar; nada é enviado.

Webhook​

O botão envia uma requisição do servidor para o endereço que você definir:

CampoPara que serve
MethodPOST, PUT ou PATCH.
URLO endereço chamado. Aceita {{variáveis}}.
HeadersPares de chave e valor (até 20), como Authorization.
BodyO corpo da requisição. Já vem com um JSON com os dados do clique.
Mensagem de sucessoO que o cliente vê quando a chamada dá certo.

Variáveis disponíveis na URL, nos headers e no corpo: {{button_label}}, {{page_path}}, {{triggered_at}}, {{customer_name}}, {{customer_email}}, {{tenant_id}}, {{portal_user_id}} e {{organization_name}}. Num corpo JSON, escreva a variável entre aspas ("{{customer_name}}") — o valor é escapado. Sem um header Content-Type, o envio vai como application/json.

:::warning Tokens e chaves de API Para guardar um token, clique em Secreto ao lado do valor do header, digite o valor e clique em Salvar. Ele é guardado criptografado: nem a página, nem a IA, nem quem abre o Construtor consegue lê-lo de volta — o painel mostra só Valor secreto salvo (criptografado), com a opção Trocar. Nunca escreva um segredo direto no campo de valor ou no corpo. :::

Se a chamada falhar, o cliente vê só um aviso genérico.

Testar no Construtor​

O preview do Construtor executa as ações de verdade: o e-mail do formulário é enviado, o webhook é chamado e o botão mostra como o endereço respondeu (status e tempo). Use destinatários e endereços de teste enquanto monta a página.

Onde ver os envios​

O quêOnde
Cada envio de formulárioEvento portal_form.submitted em Eventos
Cada clique em botão com webhookEvento portal_action.triggered em Eventos
Os e-mails enviados pelos formuláriosHistórico de Notificações
As entregas para webhooks do workspaceEntregas