Searching for

Integrar formulários externos

Se você já utiliza algum tipo de formulário em seu produto ou website, é possível integrá-los ao nosso sistema para rastrear os cadastros e eventos de identificação. Sugerimos este método caso não possa utilizar os formulários web que o próprio sistema já oferece.

Integrando um formulário já existente

Utilizando a função pipz.formIdentify, você informa ao nosso sistema que trata-se de um formulário externo, que não foi construído no Pipz, mas que será utilizado para capturar eventos de identificação, logins e novos cadastros.

Para realizar a integração, adicione o seguinte script entre as tags <body> e </body onde o formulário está presente. As variáveis selector e map são obrigatórias:

<script>
pipz.ready(function(){

    pipz.formIdentify({
      selector: string, //Campo obrigatório
      onSubmit: function(e){
                e.preventDefault();
              },
      map: {
        name: nome da input,
        email: nome da input 
       }
    });
});
</script>

Na variável selector deve ser informado a id ou class do formulário, como por exemplo #seuform (id) ou .seuform (class). Já na variável map, você deve informar quais são os campos que serão enviados com o método de identificação do contato.

No exemplo acima, trouxemos os campos name e email, que são obrigatórios para efetivar a identificação do contato.

Campos de integração do formulário

Os campos de dados permitidos formulários externos são os mesmos campos da importação de contatos, e permite que o perfil do usuário seja criado e atualizado de acordo com as informações enviadas pelo método acima.

Database Name Tipo Descrição
name string Nome do contato
email string Endereço de e-mail do contato
birthdate datetime Data de aniversário do contato no formato AAAA-MM-DD
city_name string Nome da cidade do contato
country_name string Nome do país do contato
facebook string Perfil do Facebook do contato
gender string Gênero do contato
job_title string Cargo do contato
linkedin string Perfil do LinkedIn do contato
mobile_phone string Telefone celular do contato
phone string Telefone do contato
postal_code string CEP do contato
region_name string Estado do contato
stage_id integer ID do Lifecycle Stage do contato
twitter string Perfil do Twitter do contato
website string Site do contato
company string Nome da empresa
company_address_1 string Endereço 1 da empresa
company_address_2 string Endereço 2 da empresa
company_city_name string Nome da cidade da empresa
company_country_code string Código do país da empresa
company_country_name string Nome do país da empresa
company_email string Endereço de e-mail da empresa
company_facebook string Página do Facebook da empresa
company_linkedin string Página do LinkedIn da empresa
company_monthly_spend number Gasto mensal da empresa
company_phone string Telefone da empresa
company_plan string Plano de pagamento da empresa
company_postal_code string CEP da empresa
company_region_name string Nome do estado da empresa
company_remote_creation_date datetime Data de criação remota da empresa
company_remote_id integer ID remoto de identificação da empresa
company_state string Sigla do estado da empresa
company_twitter string Perfil do Twitter da empresa
company_website string Site da empresa

Enviar dados personalizados por campos de formulário

Além dos campos de sistema exibidos acima, você tem a possibilidade de enviar campos personalizados (custom fields, como chamamos no sistema). Na variável map basta declarar na função o campo customizado criado por você. Caso o campo adicionado não exista no sistema, ele será criado.

Veja abaixo como o script deverá ser adicionado:

<script>
pipz.ready(function(){

    pipz.formIdentify({
      selector: string, //Campo obrigatório
      onSubmit: function(e){
                e.preventDefault();
              },
      map: {
        name: nome da input,
        email: nome da input
       }
    });
});
</script>

Veja abaixo um exemplo preenchido, para ser usado como referência na integração de um formulário:

<!-- Formulário Modelo -->
<form id="meu-form">
    <label>E-mail<input type="text" name="email"></label><br>   
    <label>Nome<input type="text" name="nome"></label><br>
    <label>Categoria<input type="text" name="skype"></label><br>
    <input type="submit" value="Enviar">
</form>


<script>
pipz.ready(function(){

    pipz.formIdentify({
      selector: "#meu-form",
      onSubmit: function(e){
                e.preventDefault();
              },
      map: {
        name: "nome",
        email: "email",
        skype: "skype"
       }
    });
});
</script>