For AI agents: the complete documentation index is available at https://docs.clickmax.io/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/reference/webhooks.md.
  • Português
  • Webhooks

    O Clickmax tem dois tipos de webhook: entrada (in), que recebe eventos de uma plataforma externa, e saída (out), que envia um evento do Clickmax para uma URL externa quando um gatilho acontece.

    Papel exigido: membro autenticado do workspace. A gestão de webhooks fica na área de Integrações.

    Direção

    TipoSentidoO que é
    inPlataforma externa → ClickmaxRecebe dados via uma URL própria (https://webhooks.<seu-domínio>/<slug>), validada por token.
    outClickmax → plataforma externaDispara um POST para a URL configurada quando o gatilho ocorre.

    Plataformas de entrada

    Valores aceitos ao criar um webhook de entrada.

    PlataformaIdentificadorComo configurar
    ActiveCampaignactivecampaign—
    Asaasasaas—
    Braipbraip—
    CartPandacartpanda—
    EduzzeduzzIntegrar Eduzz
    Greenngreenn—
    Digital Manager GuruguruIntegrar Guru
    HotmarthotmartIntegrar Hotmart
    HotWebinarhotwebinar—
    HublahublaIntegrar Hubla
    KirvanokirvanoIntegrar Kirvano
    KiwifykiwifyIntegrar Kiwify
    Kommokommo—
    LastlinklastlinkIntegrar Lastlink
    ManyChatmanychat—
    Monetizzemonetizze—
    NuvemshopnuvemshopIntegrar Nuvemshop
    Pagar.mepagarmeIntegrar Pagar.me
    PerfectPayperfectpay—
    PrincipiaprincipiaIntegrar Principia
    ShopifyshopifyIntegrar Shopify
    StripestripeIntegrar Stripe
    TictotictoIntegrar Ticto
    TMB (Tem Mais no Boleto)tmb—
    VoompvoompIntegrar Voomp
    VStagevstage—
    Vunelvunel—
    WebinarKitwebinarkit—
    WhopwhopIntegrar Whop
    Yampiyampi—
    YeveryeverIntegrar Yever

    Plataformas de saída

    Destinos aceitos ao criar um webhook de saída.

    PlataformaIdentificador
    ActiveCampaignactivecampaignout
    Basecampbasecamp
    Calendlycalendly
    Circlecircle
    Clickmax (funil/tag interno)clickmax
    Discorddiscord
    Google Drivedrive
    Dropboxdropbox
    Eventbriteeventbrite
    Google Sheetsgooglesheets
    HubSpothubspot
    Intercomintercom
    JivoChatjivochat
    Makemake
    n8nn8n
    Nibonibo
    Nota do Infoprodutornotadoinfoprodutor
    Notazznotazz
    Notionnotion
    Outsideroutsider
    Pipedrivepipedrive
    PipeRunpiperun
    Plugapluga
    QuickBooksquickbooks
    RD Stationrdstation
    Shopifyshopify
    Slackslack
    Somos BIUsomosbiu
    UTMifyutmify
    VK Metricsvkmetrics
    WooCommercewoocommerce
    Zapierzapier
    Zendeskzendesk
    Zoom Webinarzoomwebinar

    Gatilhos

    Eventos que disparam um webhook de saída (campo trigger).

    GatilhoQuando dispara
    ABANDONED_CARTCarrinho abandonado
    CHARGEBACK_REQUESTEDChargeback solicitado
    FUNNEL_CREATEDFunil criado
    FUNNEL_DELETEDFunil excluído
    FUNNEL_EDITEDFunil editado
    LEAD_CAPTUREDLead capturado
    LEAD_CREATEDLead criado
    PAGE_DELETEDPágina excluída
    PIX_OR_BOLETO_EXPIRED_OR_OVERDUEPix ou boleto expirado/vencido
    PROJECT_CREATEDProjeto criado
    PROJECT_DELETEDProjeto excluído
    REFUND_MADEReembolso realizado
    REFUSED_CARDCartão recusado na cobrança (uma vez por tentativa)
    SALE_CANCELLEDVenda cancelada
    SALE_MADEVenda realizada
    SUBSCRIPTION_CANCELLEDAssinatura cancelada
    SUBSCRIPTION_STARTEDAssinatura iniciada
    TAG_ADDEDTag adicionada
    TAG_REMOVEDTag removida
    TRANSACTION_FAILEDTransação falhou

    Cartão recusado x transação falhou

    REFUSED_CARD dispara uma vez por tentativa de pagamento em que o cartão foi enviado à cobrança e recusado. Uma segunda tentativa do comprador com o mesmo cartão, alguns minutos depois, é uma nova recusa e dispara de novo.

    Compra que nem chega à cobrança — cartão obrigatório não informado, produto sem estoque, conta do vendedor pendente, endereço de entrega faltando — não é recusa de cartão: dispara só TRANSACTION_FAILED. Pix e boleto que falham também usam apenas TRANSACTION_FAILED.

    Venda ou fatura de renovação no SALE_MADE

    SALE_MADE dispara na compra e também em cada fatura de renovação paga de uma assinatura, a partir da segunda cobrança. O campo isSubscriptionInvoice diferencia os dois casos: false na compra, true na fatura de renovação.

    Nas faturas de renovação de assinaturas vendidas no seu checkout, o corpo traz também subscriptionId, subscriptionExternalId (código da assinatura no gateway), occurrence e purchaseDate (data da compra original). Nessas faturas, saleDate é a data da cobrança da parcela.

    O campo occurrence é o número da cobrança informado pelo gateway e pode pular números, porque o gateway também conta o reenvio de uma cobrança vencida. Para saber em qual ciclo a assinatura está, conte as faturas recebidas com o mesmo subscriptionId.

    Quando SUBSCRIPTION_CANCELLED dispara

    Em qualquer cancelamento de assinatura, independentemente da origem: cancelamento pelo comprador, por você ou pelo suporte, cancelamento automático por falta de pagamento depois do período de tolerância, e o cancelamento que acompanha um reembolso.

    Assinatura que chegou ao fim da duração contratada (última cobrança prevista do plano) não é cancelamento e não dispara este gatilho.

    Formato da requisição (saída)

    Quando um gatilho acontece, o Clickmax envia uma requisição para a URL da integração com o seguinte formato:

    ItemValor
    MétodoPOST
    URLA URL cadastrada na integração, exatamente como foi informada (inclusive a query string).
    Content-Typeapplication/json
    cm-tokenO token da integração, exibido na tela de configuração do webhook.
    CorpoObjeto JSON com os campos do evento, descritos em Corpo de cada evento.

    Autenticação

    A requisição é autenticada pelo cabeçalho cm-token. No seu endpoint, compare o valor recebido com o token exibido na integração e recuse a requisição (por exemplo, com 401) se forem diferentes. O token é fixo por integração; não há assinatura HMAC do corpo.

    Como identificar o evento

    O corpo não traz o nome do gatilho. Uma mesma integração pode escutar vários gatilhos e todos chegam na mesma URL, então use uma destas opções para saber qual evento chegou:

    • crie uma integração por gatilho, cada uma com uma URL diferente (por exemplo, https://seu-sistema.com/webhook?evento=SALE_MADE);
    • ou diferencie pelos campos do corpo, que mudam de um evento para outro (veja as tabelas abaixo).

    Resposta, novas tentativas e desativação

    • Qualquer resposta 2xx conta como entrega concluída (COMPLETED). O conteúdo da resposta é guardado no histórico.
    • Qualquer outra resposta (como 4xx ou 5xx) ou falha de conexão gera nova tentativa. São até 3 tentativas por evento, com espera crescente entre elas (cerca de 10 e 20 segundos). Enquanto aguarda, o registro fica DELAYED; depois da última falha, FAILED.
    • Se as 15 últimas tentativas da integração falharem, ela é desativada automaticamente. Corrija o endpoint, reative a integração e reenvie os registros pelo histórico.
    • Responda rápido e processe o evento depois: o mesmo evento pode chegar mais de uma vez (por exemplo, num reenvio manual), então trate o corpo de forma idempotente, usando IDs como transactionId ou leadId.

    Plataformas com formato próprio

    O formato acima vale para os destinos genéricos (Zapier, Make, n8n, Pluga, URL do seu sistema etc.). ActiveCampaign, Nota do Infoprodutor, Notazz, UTMify e VK Metrics recebem o evento já convertido para o formato e a autenticação exigidos por cada plataforma, e não seguem as tabelas abaixo.

    Corpo de cada evento

    Cada tabela lista os campos exatamente como chegam no JSON:

    • Obrigatório: o campo sempre vem no corpo. Quando é Não, o campo pode não existir no JSON.
    • Aceita null: o campo pode vir com o valor null.
    • Pode vir vazio: o campo de texto pode vir como string vazia (""), por exemplo quando o dado não foi coletado.
    • Campos pai.filho estão dentro de um objeto; campos pai[].filho estão em cada item de uma lista.
    • Datas são strings ISO 8601 em UTC (por exemplo, 2026-01-15T14:30:00.000Z).
    • Valores monetários são inteiros em centavos (9700 = 97,00). A moeda não é enviada.

    Os exemplos usam dados fictícios. São os mesmos corpos enviados pelo botão de teste da integração, exceto IDs e datas, que no teste são gerados na hora.

    Lead criado e lead capturado

    Gatilhos: LEAD_CREATED, LEAD_CAPTURED.

    LEAD_CREATED dispara uma vez, quando o lead passa a existir. LEAD_CAPTURED dispara a cada captura, inclusive quando um lead que já existe preenche um formulário de novo. Campos sem valor no lead não vêm no corpo.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    fullnamestringNãoNãoNãoNome completo do lead.
    emailstring (e-mail)NãoNãoNãoE-mail do lead.
    telephonestringNãoNãoNãoTelefone do lead, em dígitos (pode começar com +).
    pageIdstring (UUID)NãoNãoNãoID da página da captura. Não vem quando a captura não foi em uma página (por exemplo, pelo chat do site).
    pageUrlstringNãoNãoNãoEndereço completo da página da captura, com https://.
    pageNamestringNãoNãoNãoNome da página da captura.
    funnelIdstring (UUID)NãoNãoNãoID do funil da página.
    funnelNamestringNãoNãoNãoNome do funil da página.
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    extraParamsobjectNãoNão—Parâmetros de rastreio de parceiros, além das UTMs.
    extraParams.vkSourcestringNãoNãoNãoParâmetro vk_source da visita (VK Metrics).
    extraParams.vkAdIdstringNãoNãoNãoParâmetro vk_adid da visita (VK Metrics).
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.
    capturedAtstring (ISO 8601)SimNãoNãoData e hora em que o Clickmax processou a captura.

    Exemplo de corpo:

    {
      "fullname": "Fullname",
      "email": "example@email.com",
      "telephone": "9538374457",
      "pageId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "pageUrl": "https://clickmax.io",
      "pageName": "Page name",
      "funnelId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "funnelName": "Funnel name",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2",
      "capturedAt": "2026-01-15T14:30:00.000Z"
    }

    Venda realizada

    Gatilhos: SALE_MADE.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    emailstring (e-mail)SimNãoNãoE-mail do comprador.
    documentstringNãoSimNãoCPF (11 dígitos) ou CNPJ (14 dígitos) do comprador, só números.
    firstNamestringSimNãoNãoPrimeiro nome do comprador.
    lastNamestringSimNãoSimSobrenome do comprador. Vazio quando foi informado só um nome.
    phonestringSimNãoSimTelefone do comprador: código do país, DDD e número, só dígitos.
    citystringNãoSimNãoCidade do comprador.
    statestringNãoSimNãoEstado (UF) do comprador.
    countrystringNãoSimNãoPaís do comprador, código ISO de duas letras (por exemplo, BR).
    addressstringSimNãoSimEndereço do comprador em uma linha: rua, número, complemento, bairro e CEP, separados por vírgula. Vazio quando o endereço não foi informado.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    productIdstring (UUID)SimNãoNãoID do produto.
    productNamestringSimNãoNãoNome do produto.
    saleDatestring (ISO 8601)SimNãoNãoData e hora de criação da transação. Na fatura de renovação, é a data desta cobrança.
    pricenumberSimNão—Valor em centavos. Na compra pelo checkout é o preço da oferta, sem desconto de cupom; em cobranças de fatura e renovação, é o valor cobrado.
    utmSourcestringSimNãoSimParâmetro utm_source da visita.
    utmMediumstringSimNãoSimParâmetro utm_medium da visita.
    utmCampaignstringSimNãoSimParâmetro utm_campaign da visita.
    utmTermstringSimNãoSimParâmetro utm_term da visita.
    utmContentstringSimNãoSimParâmetro utm_content da visita.
    srcstringSimNãoSimParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringSimNãoSimParâmetro livre sck da URL, usado para atribuir a conversão.
    pageUrlstringSimNãoNãoEndereço da página de checkout da venda.
    pageNamestringSimNãoSimNome da página de checkout. Vazio quando a venda não veio de uma página do editor.
    gatewaystringSimNãoNãoGateway de pagamento da transação (por exemplo, IOPAY ou TICTO). Compare sem diferenciar maiúsculas de minúsculas.
    orderBumpsarraySimNão—Order bumps comprados junto. Lista vazia quando não houve.
    orderBumps[].offerIdstring (UUID)SimNãoNãoID da oferta do order bump.
    orderBumps[].productIdstring (UUID)SimNãoNãoID do produto do order bump.
    orderBumps[].pricenumberSimNão—Preço do order bump, em centavos.
    orderBumps[].productNamestringSimNãoNãoNome do produto do order bump.
    transactionIdstring (UUID)SimNãoNãoID da transação.
    isSubscriptionInvoicebooleanSimNão—true quando a venda é a fatura de renovação de uma assinatura (da segunda cobrança em diante); false na compra.
    subscriptionIdstring (UUID)NãoNãoNãoSó na fatura de renovação. ID da assinatura no Clickmax (o mesmo subscriptionId de SUBSCRIPTION_CANCELLED e transactionId de SUBSCRIPTION_STARTED).
    subscriptionExternalIdstringNãoNãoNãoSó na fatura de renovação. Código da assinatura no gateway de pagamento.
    occurrenceintegerNãoSim—Só na fatura de renovação. Número da cobrança informado pelo gateway; pode pular números, porque o gateway também conta o reenvio de uma cobrança vencida.
    purchaseDatestring (ISO 8601)NãoNãoNãoSó na fatura de renovação. Data e hora da compra original da assinatura.

    Exemplo de corpo:

    {
      "email": "example@email.com",
      "document": "12345678909",
      "firstName": "First Name",
      "lastName": "Last Name",
      "phone": "5538933008932",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
      "offerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "productId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "productName": "Product Name",
      "saleDate": "2026-01-15T14:30:00.000Z",
      "price": 9700,
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2",
      "pageUrl": "https://test.clickmax.io/test-clickmax",
      "pageName": "Test Clickmax",
      "gateway": "iopay",
      "orderBumps": [
        {
          "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
          "productId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
          "price": 2700,
          "productName": "Product Name"
        }
      ],
      "transactionId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
      "isSubscriptionInvoice": true,
      "subscriptionId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
      "subscriptionExternalId": "SUB-8F3K2L",
      "occurrence": 3,
      "purchaseDate": "2025-11-16T14:30:00.000Z"
    }

    Venda cancelada, reembolso e chargeback

    Gatilhos: SALE_CANCELLED, REFUND_MADE, CHARGEBACK_REQUESTED.

    Os três gatilhos enviam o mesmo corpo; o que muda é o motivo. Configure uma URL por gatilho para diferenciá-los.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    buyerIdstring (UUID)SimNãoNãoID do comprador no Clickmax.
    leadIdstring (UUID)SimNãoNãoID do lead no Clickmax.
    emailstring (e-mail)SimNãoNãoE-mail do comprador.
    namestringSimNãoNãoNome do comprador.
    phonestringSimNãoNãoTelefone do comprador: código do país, DDD e número.
    documentstringNãoSimNãoCPF (11 dígitos) ou CNPJ (14 dígitos) do comprador, só números.
    citystringNãoSimNãoCidade do comprador.
    statestringNãoSimNãoEstado (UF) do comprador.
    countrystringNãoSimNãoPaís do comprador, código ISO de duas letras (por exemplo, BR).
    addressstringSimNãoSimEndereço do comprador em uma linha: rua, número, complemento, bairro e CEP, separados por vírgula. Vazio quando o endereço não foi informado.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    productIdstring (UUID)SimNãoNãoID do produto.
    productNamestringSimNãoNãoNome do produto.
    pricenumberSimNão—Preço de tabela da oferta, em centavos.
    transactionIdstring (UUID)SimNãoNãoID da transação.
    gatewaystringSimNãoNãoGateway de pagamento da transação (por exemplo, IOPAY ou TICTO). Compare sem diferenciar maiúsculas de minúsculas.
    cancelledDatestring (ISO 8601)SimNãoNãoData e hora em que o Clickmax processou o cancelamento, reembolso ou chargeback.
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.

    Exemplo de corpo:

    {
      "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "email": "example@email.com",
      "name": "Buyer Name",
      "phone": "5538933008932",
      "document": "12345678900",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
      "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "productId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "productName": "Product Name",
      "price": 9700,
      "transactionId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
      "gateway": "iopay",
      "cancelledDate": "2026-01-15T14:30:00.000Z",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2"
    }

    Assinatura iniciada

    Gatilhos: SUBSCRIPTION_STARTED.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    emailstring (e-mail)SimNãoNãoE-mail do comprador.
    documentstringNãoSimNãoCPF (11 dígitos) ou CNPJ (14 dígitos) do comprador, só números.
    firstNamestringSimNãoNãoPrimeiro nome do comprador.
    lastNamestringSimNãoSimSobrenome do comprador. Vazio quando foi informado só um nome.
    phonestringSimNãoSimTelefone do comprador: código do país, DDD e número, só dígitos.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    orderBumpsarraySimNão—Order bumps comprados junto. Lista vazia quando não houve.
    orderBumps[].offerIdstring (UUID)SimNãoNãoID da oferta do order bump.
    orderBumps[].productIdstring (UUID)SimNãoNãoID do produto do order bump.
    orderBumps[].pricenumberSimNão—Preço do order bump, em centavos.
    orderBumps[].productNamestringSimNãoNãoNome do produto do order bump.
    transactionIdstring (UUID)SimNãoNãoID da assinatura criada (o mesmo enviado como subscriptionId em SUBSCRIPTION_CANCELLED).
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.

    Exemplo de corpo:

    {
      "email": "example@email.com",
      "document": "12345678900",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "5538933008932",
      "offerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "orderBumps": [
        {
          "offerId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
          "productId": "d3429377-199d-4075-aa4c-9a32d327a877",
          "price": 2700,
          "productName": "Product Name"
        }
      ],
      "transactionId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2"
    }

    Assinatura cancelada

    Gatilhos: SUBSCRIPTION_CANCELLED.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    buyerIdstring (UUID)SimNãoNãoID do comprador no Clickmax.
    leadIdstring (UUID)SimNãoNãoID do lead no Clickmax.
    emailstring (e-mail)SimNãoNãoE-mail do comprador.
    namestringSimNãoNãoNome do comprador.
    telephonestringSimNãoNãoTelefone do comprador: código do país, DDD e número.
    documentstringNãoSimNãoCPF (11 dígitos) ou CNPJ (14 dígitos) do comprador, só números.
    citystringNãoSimNãoCidade do comprador.
    statestringNãoSimNãoEstado (UF) do comprador.
    countrystringNãoSimNãoPaís do comprador, código ISO de duas letras (por exemplo, BR).
    addressstringSimNãoSimEndereço do comprador em uma linha: rua, número, complemento, bairro e CEP, separados por vírgula. Vazio quando o endereço não foi informado.
    productNamestringSimNãoNãoNome do produto.
    pricenumberSimNão—Preço de tabela da oferta, em centavos.
    subscriptionStatusstringSimNãoNãoStatus da assinatura antes do cancelamento (normalmente active).
    subscriptionIdstring (UUID)SimNãoNãoID da assinatura.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    productIdstring (UUID)SimNãoNãoID do produto.
    frequencystringSimNãoNãoRecorrência da cobrança (por exemplo, monthly, quarterly, semiannual, yearly).
    gatewaystringSimNãoNãoGateway de pagamento da transação (por exemplo, IOPAY ou TICTO). Compare sem diferenciar maiúsculas de minúsculas.
    cancelledDatestring (ISO 8601)SimNãoNãoData e hora do cancelamento.
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.

    Exemplo de corpo:

    {
      "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "email": "example@email.com",
      "name": "Buyer Name",
      "telephone": "5538933008932",
      "document": "12345678900",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
      "productName": "Product Name",
      "price": 9700,
      "subscriptionStatus": "canceled",
      "subscriptionId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "offerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "productId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
      "frequency": "monthly",
      "gateway": "iopay",
      "cancelledDate": "2026-01-15T14:30:00.000Z",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2"
    }

    Carrinho abandonado

    Gatilhos: ABANDONED_CART.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    leadIdstring (UUID)SimNãoNãoID do lead no Clickmax.
    leadNamestringNãoSimNãoNome do lead.
    leadEmailstring (e-mail)NãoSimNãoE-mail do lead.
    leadDocumentstringNãoSimNãoCPF ou CNPJ do lead.
    leadCitystringNãoSimNãoCidade do lead.
    leadTelephonestringNãoSimNãoTelefone do lead, em dígitos (pode começar com +).
    leadWhatsappNumberstringNãoSimNãoWhatsApp do lead, em dígitos.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    offerNamestringSimNãoNãoNome da oferta.
    offerPricenumberSimNão—Preço da oferta, em centavos.
    offerTypestring (enum)SimNãoNãoTipo do produto da oferta (por exemplo, course, ebook, software). Valores possíveis: community, course, ebook, event, physical, other, services, software, consultancy, mentorship.
    ownerIdstring (UUID)SimNãoNãoID da conta do vendedor.
    projectIdstring (UUID)SimNãoNãoID do projeto da oferta.
    productIdstring (UUID)SimNãoNãoID do produto.
    abandonedDatestring (ISO 8601)SimNãoNãoData e hora em que o abandono foi registrado.
    stagestring (enum)NãoNãoNãoEtapa em que o checkout parou: personal_data (dados pessoais) ou payment_data (pagamento). Valores possíveis: personal_data, payment_data.
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.

    Exemplo de corpo:

    {
      "leadId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "leadName": "Lead Name",
      "leadEmail": "lead@email.com",
      "leadDocument": "12345678909",
      "leadCity": "City",
      "leadTelephone": "5538933008932",
      "leadWhatsappNumber": "5538933008932",
      "offerId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "offerName": "Meu produto",
      "offerPrice": 9700,
      "offerType": "software",
      "ownerId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "projectId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "productId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
      "abandonedDate": "2026-01-15T14:30:00.000Z",
      "stage": "personal_data",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2"
    }

    Cartão recusado

    Gatilhos: REFUSED_CARD.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    buyerIdstring (UUID)SimNãoNãoID do comprador. Vem como 00000000-0000-0000-0000-000000000000 quando o comprador ainda não existe.
    leadIdstring (UUID)SimNãoNãoID do lead no Clickmax.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    offerNamestringSimNãoNãoNome da oferta.
    offerPricenumberSimNão—Preço da oferta, em centavos.
    offerTypestringSimNãoSimTipo do produto da oferta (por exemplo, course, ebook, software).
    buyerEmailstring (e-mail)SimNãoNãoE-mail do comprador.
    buyerNamestringSimNãoNãoNome do comprador.
    buyerTelephonestringSimNãoSimTelefone do comprador, só dígitos (código do país, DDD e número).
    ownerIdstring (UUID)SimNãoNãoID da conta do vendedor.
    projectIdstring (UUID)SimNãoNãoID do projeto da oferta.
    productIdstring (UUID)SimNãoNãoID do produto.
    refusedDatestring (ISO 8601)SimNãoNãoData e hora da recusa.
    failReasonstringNãoSimNãoMotivo informado pelo gateway, quando houver.
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.

    Exemplo de corpo:

    {
      "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "offerName": "Meu produto",
      "offerPrice": 9700,
      "offerType": "software",
      "buyerEmail": "buyer@email.com",
      "buyerName": "Buyer Name",
      "buyerTelephone": "5538933008932",
      "ownerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "projectId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
      "productId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
      "refusedDate": "2026-01-15T14:30:00.000Z",
      "failReason": "Cartão recusado pela operadora",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2"
    }

    Transação falhou

    Gatilhos: TRANSACTION_FAILED.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    buyerIdstring (UUID)NãoSimNãoID do comprador no Clickmax.
    leadIdstring (UUID)NãoSimNãoID do lead no Clickmax.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    offerNamestringSimNãoNãoNome da oferta.
    offerPricenumberSimNão—Preço da oferta, em centavos.
    offerTypestringSimNãoNãoTipo do produto da oferta (por exemplo, course, ebook, software).
    buyerEmailstring (e-mail)SimNãoNãoE-mail do comprador.
    buyerNamestringSimNãoNãoNome do comprador.
    buyerTelephonestringNãoSimNãoTelefone do comprador. Hoje este evento não envia o campo.
    ownerIdstring (UUID)SimNãoNãoID da conta do vendedor.
    projectIdstring (UUID)SimNãoNãoID do projeto da oferta.
    productIdstring (UUID)SimNãoNãoID do produto.
    paymentTypestringSimNãoNãoForma de pagamento que falhou (por exemplo, credit, pix, boleto).
    failedDatestring (ISO 8601)SimNãoNãoData e hora da falha.
    failReasonstringNãoSimNãoMensagens de erro do gateway, separadas por ; , quando houver.
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.

    Exemplo de corpo:

    {
      "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "offerName": "Meu produto",
      "offerPrice": 9700,
      "offerType": "software",
      "buyerEmail": "buyer@email.com",
      "buyerName": "Buyer Name",
      "buyerTelephone": "5538933008932",
      "ownerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "projectId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
      "productId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
      "paymentType": "credit",
      "failedDate": "2026-01-15T14:30:00.000Z",
      "failReason": "Falha ao processar a transação",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2"
    }

    Pix ou boleto expirado ou vencido

    Gatilhos: PIX_OR_BOLETO_EXPIRED_OR_OVERDUE.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    buyerIdstring (UUID)SimNãoNãoID do comprador no Clickmax.
    leadIdstring (UUID)SimNãoNãoID do lead no Clickmax.
    offerIdstring (UUID)SimNãoNãoID da oferta.
    offerNamestringSimNãoNãoNome da oferta.
    offerPricenumberSimNão—Preço da oferta, em centavos.
    offerTypestringSimNãoNãoTipo do produto da oferta (por exemplo, course, ebook, software).
    buyerEmailstring (e-mail)SimNãoNãoE-mail do comprador.
    buyerNamestringSimNãoNãoNome do comprador.
    buyerDocumentstringNãoSimNãoCPF (11 dígitos) ou CNPJ (14 dígitos) do comprador, só números.
    buyerTelephonestringSimNãoSimTelefone do comprador, só dígitos (código do país, DDD e número).
    citystringNãoSimNãoCidade do comprador.
    statestringNãoSimNãoEstado (UF) do comprador.
    countrystringNãoSimNãoPaís do comprador, código ISO de duas letras (por exemplo, BR).
    addressstringSimNãoSimEndereço do comprador em uma linha: rua, número, complemento, bairro e CEP, separados por vírgula. Vazio quando o endereço não foi informado.
    ownerIdstring (UUID)SimNãoNãoID da conta do vendedor.
    projectIdstring (UUID)SimNãoNãoID do projeto da oferta.
    productIdstring (UUID)SimNãoNãoID do produto.
    expiredDatestring (ISO 8601)SimNãoNãoData e hora em que o Clickmax identificou a expiração ou o vencimento.
    utmSourcestringNãoNãoNãoParâmetro utm_source da visita.
    utmMediumstringNãoNãoNãoParâmetro utm_medium da visita.
    utmCampaignstringNãoNãoNãoParâmetro utm_campaign da visita.
    utmTermstringNãoNãoNãoParâmetro utm_term da visita.
    utmContentstringNãoNãoNãoParâmetro utm_content da visita.
    srcstringNãoNãoNãoParâmetro livre src da URL, usado por ferramentas como VTurb e UTMify para atribuir a conversão.
    sckstringNãoNãoNãoParâmetro livre sck da URL, usado para atribuir a conversão.

    Exemplo de corpo:

    {
      "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "offerName": "Meu produto",
      "offerPrice": 9700,
      "offerType": "software",
      "buyerEmail": "buyer@email.com",
      "buyerName": "Buyer Name",
      "buyerDocument": "12345678909",
      "buyerTelephone": "5538933008932",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
      "ownerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "projectId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
      "productId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
      "expiredDate": "2026-01-15T14:30:00.000Z",
      "utmSource": "source",
      "utmMedium": "medium",
      "utmCampaign": "campaign",
      "utmTerm": "term",
      "utmContent": "content",
      "src": "vturb_vsl_01",
      "sck": "lote2"
    }

    Tag adicionada e tag removida

    Gatilhos: TAG_ADDED, TAG_REMOVED.

    Os campos de contato são do lead que recebeu ou perdeu a tag.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    idstring (UUID)SimNãoNãoID da tag (não do lead).
    emailstring (e-mail)NãoSimNãoE-mail do lead.
    namestringNãoSimNãoNome do lead.
    telephonestringNãoSimNãoTelefone do lead.
    whatsappNumberstringNãoSimNãoWhatsApp do lead.
    secondaryEmailstringNãoSimNãoE-mail secundário do lead.
    nameTagstringSimNãoNãoNome da tag.
    colorTagstringSimNãoNãoCor da tag em hexadecimal de 6 caracteres, sem # (por exemplo, A821D8).

    Exemplo de corpo:

    {
      "id": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
      "email": "example@email.com",
      "name": "Buyer Name",
      "telephone": "5538933008932",
      "whatsappNumber": "5538933008932",
      "secondaryEmail": "example2@email.com",
      "nameTag": "Tag Name",
      "colorTag": "1b0570"
    }

    Funil criado e funil excluído

    Gatilhos: FUNNEL_CREATED, FUNNEL_DELETED.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    namestringSimNãoNãoNome do funil.
    descriptionstringNãoSimNãoDescrição do funil.
    funnelUrlstringSimNãoSimEndereço do funil, sem https:// (por exemplo, meudominio.com/f/meu-funil). Pode vir vazio na exclusão causada pela exclusão do projeto, quando o funil não tem domínio próprio.
    pathstringSimNãoNãoCaminho (slug) do funil.
    typestringNãoSimNãoModelo do funil escolhido na criação (por exemplo, vsl, webinar, leadMagnet).
    categorystring (enum)NãoSimNãoCategoria do funil. Valores possíveis: basic, premium, special.

    Exemplo de corpo:

    {
      "name": "Funnel name",
      "description": "Funnel description",
      "funnelUrl": "new-project-5250.clickmax.localhost/funnel-name",
      "path": "funnel-name",
      "type": "sequentialSales",
      "category": "basic"
    }

    Funil editado

    Gatilhos: FUNNEL_EDITED.

    Traz o funil inteiro antes (oldFields) e depois (newFields) da edição. Só dispara quando algum desses campos mudou.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    oldFieldsobjectNãoNão—Funil antes da edição.
    oldFields.namestringSimNãoNãoAntes: Nome do funil.
    oldFields.descriptionstringNãoSimNãoAntes: Descrição do funil.
    oldFields.funnelUrlstringSimNãoSimAntes: Endereço do funil, sem https:// (por exemplo, meudominio.com/f/meu-funil). Pode vir vazio na exclusão causada pela exclusão do projeto, quando o funil não tem domínio próprio.
    oldFields.pathstringSimNãoNãoAntes: Caminho (slug) do funil.
    oldFields.typestringNãoSimNãoAntes: Modelo do funil escolhido na criação (por exemplo, vsl, webinar, leadMagnet).
    oldFields.categorystring (enum)NãoSimNãoAntes: Categoria do funil. Valores possíveis: basic, premium, special.
    newFieldsobjectNãoNão—Funil depois da edição.
    newFields.namestringSimNãoNãoDepois: Nome do funil.
    newFields.descriptionstringNãoSimNãoDepois: Descrição do funil.
    newFields.funnelUrlstringSimNãoSimDepois: Endereço do funil, sem https:// (por exemplo, meudominio.com/f/meu-funil). Pode vir vazio na exclusão causada pela exclusão do projeto, quando o funil não tem domínio próprio.
    newFields.pathstringSimNãoNãoDepois: Caminho (slug) do funil.
    newFields.typestringNãoSimNãoDepois: Modelo do funil escolhido na criação (por exemplo, vsl, webinar, leadMagnet).
    newFields.categorystring (enum)NãoSimNãoDepois: Categoria do funil. Valores possíveis: basic, premium, special.

    Exemplo de corpo:

    {
      "oldFields": {
        "name": "Old funnel name",
        "description": "Old funnel description",
        "funnelUrl": "new-project-5250.clickmax.localhost/old-funnel-name",
        "path": "old-funnel-name",
        "type": "sequentialSales",
        "category": "basic"
      },
      "newFields": {
        "name": "Funnel name",
        "description": "Funnel description",
        "funnelUrl": "new-project-5250.clickmax.localhost/funnel-name",
        "path": "funnel-name",
        "type": "sequentialSales",
        "category": "basic"
      }
    }

    Página excluída

    Gatilhos: PAGE_DELETED.

    Também dispara para cada página quando o projeto inteiro é excluído.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    namestringSimNãoNãoNome da página.
    slugstringSimNãoNãoCaminho da página, começando com /.
    pageUrlstringNãoNãoNãoEndereço da página no domínio próprio, sem https://. Não vem quando a página não usa domínio próprio.
    typestring (enum)NãoNãoNãoTipo da página. Valores possíveis: advertorial, capture, quiz, presell, sales, checkout, upsell, downsell, termsPrivacy, thankYou, vsl, webinar.

    Exemplo de corpo:

    {
      "name": "Page name",
      "slug": "page-slug",
      "pageUrl": "https://test.clickmax.io/page-slug",
      "type": "sales"
    }

    Projeto criado e projeto excluído

    Gatilhos: PROJECT_CREATED, PROJECT_DELETED.

    CampoTipoObrigatórioAceita nullPode vir vazio ("")Descrição
    namestringSimNãoNãoNome do projeto.

    Exemplo de corpo:

    {
      "name": "Project name"
    }

    Status dos registros

    Cada entrega gera um registro com um destes status.

    StatusSignificadoAplica-se a
    PROCESSINGRecebido/enviado, em processamentoentrada e saída
    COMPLETEDProcessado com sucessoentrada e saída
    DELAYEDEntrega adiada para nova tentativaapenas saída
    FAILEDFalhou. Na saída, as tentativas automáticas acabaram; reenvie pelo histórico da integraçãoentrada e saída

    Relacionados

    Se não funcionou

    • A plataforma recebe 401 no envio de entrada: o webhook está inativo, foi excluído, ou o token/assinatura não confere — veja Códigos de erro.
    • Webhook de saída não chega ao destino: confira o status do registro e a resposta do endpoint em Códigos de erro.
    • Dúvidas gerais sobre integrações: consulte as Perguntas frequentes.