Referência de Tipos - Documentation

O campo config é um objeto JSON que varia de acordo com o type da integração. Esta página documenta os campos esperados para cada tipo.

Automações e Webhooks

`webhook`

Envia o payload completo do evento para uma URL HTTP via POST. Consulte a documentação completa de Webhooks para detalhes do payload, assinatura HMAC e exemplos de verificação.

Campo	Tipo	Obrigatório	Descrição
`url`	string	✓	URL que receberá os eventos (pode incluir `?token=...` para autenticação simples)
`auth_token`	string	—	Token para `Authorization: Bearer {token}`
`auth_username`	string	—	Usuário para `Authorization: Basic`
`auth_password`	string	—	Senha para Basic Auth (usar com `auth_username`)
`secret`	string	—	Assina o body com HMAC-SHA256 e envia `X-Velan-Signature: sha256={hash}`

`zapier`

Idêntico ao webhook — envia o payload para o Zap URL fornecido pelo Zapier.

Campo	Tipo	Obrigatório	Descrição
`webhook_url`	string	✓	URL do Zap (Catch Hook)

`make`

Idêntico ao webhook — envia o payload para o webhook do Make (Integromat).

Campo	Tipo	Obrigatório	Descrição
`webhook_url`	string	✓	URL do webhook do Make

Analytics e Rastreamento

`meta_pixel`

Envia eventos de conversão para a API de Conversões do Meta (Facebook/Instagram Ads).

Campo	Tipo	Obrigatório	Descrição
`pixel_id`	string	✓	ID do Pixel Meta (pixel de navegador)
`access_token`	string	—	Token da Conversions API — habilita o envio server-side de conversões
`test_event_code`	string	—	Código de teste para validação no Gerenciador de Eventos

Com o pixel_id configurado, o pixel de navegador é injetado automaticamente no checkout e dispara PageView + InitiateCheckout na visualização da página — sem necessidade de comprar para validar a configuração do pixel. Mapeamento de eventos (Conversions API, server-side):

order.paid → Purchase
order.created → AddPaymentInfo
order.abandoned → AddToCart
lead.created → Lead

Até ago/2026 o order.created era enviado como InitiateCheckout. Ele passou a ser AddPaymentInfo porque o InitiateCheckout agora dispara no navegador na visualização do checkout — o funil fica na ordem padrão da Meta (InitiateCheckout → AddPaymentInfo → Purchase).

`google_analytics`

Envia eventos GA4 via Measurement Protocol.

Campo	Tipo	Obrigatório	Descrição
`measurement_id`	string	✓	ID do fluxo de dados GA4 (ex: `G-XXXXXXXXXX`)
`api_secret`	string	—	Segredo do Measurement Protocol — habilita o envio server-side de eventos
`debug`	boolean	—	Se `true`, envia para o endpoint de debug do GA4

Mapeamento de eventos:

order.paid → purchase
order.refunded → refund
order.created → begin_checkout
order.expired → order_expired
order.failed → order_failed
order.abandoned → cart_abandoned

`utmify`

Sincroniza pedidos com a plataforma Utmify para atribuição de UTMs.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do Utmify

`roigenius`

Encaminha eventos de pedido para o RoiGenius via webhook.

Campo	Tipo	Obrigatório	Descrição
`url`	string	✓	URL do webhook do RoiGenius

CRM e E-mail Marketing

`active_campaign`

Sincroniza compradores como contatos e aplica tags no ActiveCampaign.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do ActiveCampaign
`base_url`	string	✓	URL da conta (ex: `https://suaconta.api-us1.com`)

`mailchimp`

Inscreve compradores em uma lista e aplica tags no Mailchimp.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do Mailchimp
`list_id`	string	✓	ID da audience/lista de destino

`rdstation`

Envia conversões para o RD Station CRM.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave pública de API do RD Station
`conversion_paid`	string	—	Identificador de conversão para `order.paid` (padrão: `velan_order_paid`)
`conversion_refunded`	string	—	Identificador de conversão para `order.refunded` (padrão: `velan_order_refunded`)

Plataformas de Curso e Membros

`cademi`

Matricula e cancela alunos automaticamente via webhook do Cademi.

Campo	Tipo	Obrigatório	Descrição
`webhook_url`	string	✓	URL do webhook fornecida pelo Cademi

`themembers`

Gerencia acessos na plataforma TheMembers via API REST v1. Em uma compra aprovada o aluno é criado (se necessário) e matriculado no produto do TheMembers correspondente ao plano comprado; no estorno o acesso àquele produto é revogado.

Campo	Tipo	Obrigatório	Descrição
`api_token`	string	✓	Token de API (Bearer) do TheMembers

O vínculo é feito por plano: no modal da integração você seleciona um produto Velan de assinatura e, para cada plano dele (ex.: Mensal, Anual), escolhe o produto do TheMembers que aquele plano libera. Assim planos diferentes (basic / premium) podem apontar para produtos diferentes no TheMembers. O mapa é salvo em config.plan_map ({ plano_code: product_id_themembers }).

Use o api_token da sua conta de produção do TheMembers. Token de homologação não libera acesso aos alunos reais.

`curseduca`

Gerencia matrículas na plataforma CursEduca.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API da CursEduca
`access_token`	string	✓	Access Token da CursEduca
`group_id`	string	✓	ID do grupo onde o aluno será matriculado

`circle`

Gerencia membros em comunidades Circle.

Campo	Tipo	Obrigatório	Descrição
`api_token`	string	✓	Token de API do Circle
`community_host`	string	✓	Host da comunidade (ex: `suacomunidade.circle.so`)
`access_group_id`	string	✓	ID do grupo de acesso de destino

`memberkit`

Gerencia matrículas na área de membros MemberKit.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do MemberKit
`classroom_id`	string	✓	ID da turma onde o aluno será matriculado

`leadlovers`

Adiciona leads e aplica automações no LeadLovers.

Campo	Tipo	Obrigatório	Descrição
`api_token`	string	✓	Token de API do LeadLovers
`funnel_id`	string	✓	ID do funil
`machine_id`	string	✓	ID da máquina
`sequence_id`	string	✓	ID da sequência

WhatsApp e Notificações

`voxuy`

Dispara automações de WhatsApp via Voxuy.

Campo	Tipo	Obrigatório	Descrição
`api_token`	string	✓	Token de API da conta Voxuy
`account_code`	string	✓	Código da conta Voxuy
`plan_id`	string	✓	ID do plano/automação a acionar

`hotzapp`

Dispara mensagens de WhatsApp via Hotzapp.

Campo	Tipo	Obrigatório	Descrição
`webhook_url`	string	✓	URL do webhook gerada no painel do Hotzapp

Notas Fiscais

`enotas`

Emite NFS-e automaticamente via eNotas.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do eNotas
`company_id`	string	✓	ID da empresa emissora no eNotas

`notazz`

Emite NFS-e automaticamente via Notazz.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do Notazz

`plugnotas`

Emite NFS-e automaticamente via PlugNotas.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do PlugNotas

ERP e Logística

`bling`

Integra pedidos com o ERP Bling via OAuth 2.0. Além das credenciais abaixo, o fluxo OAuth precisa ser concluído — veja Bling OAuth.

Campo	Tipo	Obrigatório	Descrição
`client_id`	string	✓	Client ID do app Bling
`client_secret`	string	✓	Client Secret do app Bling
`access_token`	string	—	Preenchido automaticamente após o OAuth
`refresh_token`	string	—	Preenchido automaticamente após o OAuth

`spedy`

Integra pedidos com a plataforma de logística Spedy.

Campo	Tipo	Obrigatório	Descrição
`api_key`	string	✓	Chave de API do Spedy
`store_id`	string	✓	ID da loja no Spedy

MercadoPago

O tipo mercadopago é configurado exclusivamente via OAuth — não há campos manuais de config. Ver MercadoPago OAuth.

​Automações e Webhooks

​webhook

​zapier

​make

​Analytics e Rastreamento

​meta_pixel

​google_analytics

​utmify

​roigenius

​CRM e E-mail Marketing

​active_campaign

​mailchimp

​rdstation

​Plataformas de Curso e Membros

​cademi

​themembers

​curseduca

​circle

​memberkit

​leadlovers

​WhatsApp e Notificações

​voxuy

​hotzapp

​Notas Fiscais

​enotas

​notazz

​plugnotas

​ERP e Logística

​bling

​spedy

​MercadoPago

Automações e Webhooks

`webhook`

`zapier`

`make`

Analytics e Rastreamento

`meta_pixel`

`google_analytics`

`utmify`

`roigenius`

CRM e E-mail Marketing

`active_campaign`

`mailchimp`

`rdstation`

Plataformas de Curso e Membros

`cademi`

`themembers`

`curseduca`

`circle`

`memberkit`

`leadlovers`

WhatsApp e Notificações

`voxuy`

`hotzapp`

Notas Fiscais

`enotas`

`notazz`

`plugnotas`

ERP e Logística

`bling`

`spedy`

MercadoPago