No CRM de vendas PipeRun, você pode automatizar processos que serão realizados sempre que um gatilho for acionado, dando agilidade e economizando seu tempo gasto com execução de processos dentro da plataforma.

Através da ação automática de webhook - envio de oportunidade para URL, é possível enviar informações sobre oportunidades, empresas, pessoas e propostas para outros sistemas, utilizando o webhook do PipeRun. Os webhooks possibilitam o envio de dados de todos os eventos que ocorrem dentro do CRM. 

Para saber mais sobre possíveis falhas na execução de ações automáticas, como identificá-las e os meios de saná-las, acesse este artigo.

Atenção! Apenas usuários com nível de acesso de gestor tem acesso ao menu de ações automáticas. Para saber mais sobre níveis de acesso, acesse este artigo.

Ações automáticas não são ativadas por importações ou ações em massa. Para que estes eventos desencadeiem a execução da ação, você precisará utilizar de forma conjunta uma cadência de funil que irá transferir as oportunidades para a etapa com a ação automática. Para saber mais, acesse este artigo.

Confira o passo a passo para criar uma ação automática de webhook - envio de oportunidade para URL.

VÍDEO TUTORIAL

TÓPICOS DO ARTIGO

  1. Dados enviados via ação automática
  2. Configurando a ação automática
  3. Configurando a formatação de saída do envio de dados
  4. Testando a ação automática via Beeceptor
  5. Código com descrição das chaves disponíveis 
  6. Perguntas frequentes

DADOS ENVIADOS VIA AÇÃO AUTOMÁTICA


Com este recurso, é possível enviar os seguintes dados:

  • Dados da oportunidade: título da oportunidade, valor de produto e serviço (P&S), valor de recorrências (MRR), data de previsão de fechamento, data de criação e de fechamento, observação, status e situação, origem, temperatura, tags, motivos de perda, funil e etapa de funil, dados do usuário, dono da oportunidade, valores dos campos customizados vinculados, formulários customizados, etc.;
  • Dados da empresa vinculada à oportunidade: nome da empresa, CNPJ, CNAE, número de telefone, endereço, situação da empresa, tamanho, segmento, tags, links do website e das páginas do Facebook e LinkedIn, valores dos campos customizados vinculados, etc.;
  • Dados da pessoa vinculada à oportunidade: nome da pessoa, CPF, número de telefone, endereço, dados da empresa de trabalho, cargo, tags, data de nascimento, gênero, observações, links do website e das páginas do Facebook e Linkedin, valores dos campos customizados vinculados, etc.;
  • Dados da proposta da oportunidade: valor da proposta em produtos e serviços (P&S), valor da proposta em recorrências (MRR), parcelas de pagamento, método de pagamento, status, data de validade e de vencimento, data de primeiro pagamento de parcela de recorrência (MRR), dados de transportadora e local de entrega triangular, marcas, valores dos campos customizados vinculados, etc.;
  • Dados da ação automática: data de disparo, nome do funil e etapa onde a ação automática foi executada, tipo de gatilho de acionamento da ação automática, usuário que disparou a ação automática (caso tenha sido realizada manualmente).

CONFIGURANDO A AÇÃO AUTOMÁTICA


1. Posicione o mouse sobre o avatar da conta, localizado no canto superior direito da tela. Clique em "Ajustes e configurações".


2. A seguir, clique em "Ações automáticas", na coluna Ferramentas.


3. Nesta tela, aparecerão listadas todas as ações automáticas cadastradas na conta. Para configurar uma nova ação automática, clique em "+ Adicionar ação".

Confira também nossos artigos sobre como editar ações automáticas e como habilitar ou desabilitar ações automáticas.

4. Nesta primeira etapa será configurada a ação automática, bem como o gatilho que será responsável por executá-la.

Preencha os campos disponíveis com os seguintes dados: 

1.1. Nome da ação automática, para que seja fácil identificar esta Ação Automática na listagem;

1.2. Qual será o gatilho para ocorrer a ação?: informe qual o gatilho deve ser acionado para que a ação seja executada;

Dica: caso sejam selecionados gatilhos ao preencher formulários, será necessário selecionar o formulário que deverá ser preenchido para que a ação ocorra.

Caso selecione o gatilho  "ao adicionar uma tag na oportunidade" será necessário informar a tagque deve ser adicionada para disparar a ação automática.

1.3. Qual o tipo de ação que deseja realizar?: escolha a opção "Webhook - Envio de oportunidade para URL";

1.4. Defina a prioridade da execução da ação: informe a prioridade que a Ação Automática terá para ser enviada para a fila de execução;

A prioridade se aplica somente à Ações Automáticas configuradas para serem disparadas na mesma Etapa e com o mesmo gatilho. Para saber mais, acesse este artigo.

1.5. Agendar execução da ação (Opcional): defina uma faixa de dia e horário para executar a ação. Caso a ação seja acionada fora dessa faixa, ela será automaticamente agendada para o próximo dia e horário disponível;

1.6. Quanto tempo após o gatilho a ação será enviada para fila de execução? (Opcional): defina o intervalo de tempo entre o momento em que o gatilho é disparado e a ação é enviada para a fila para ser executada (por exemplo, 5 minutos após a oportunidade entrar na etapa).

Dica: os tempos de espera variam entre "Imediatamente", quando a ação é enviada para execução no momento em que o gatilho é disparado, sem atraso, ou um tempo "Personalizado", onde é possível definir um período de espera em minutos, horas ou dias, com limite máximo de 7 dias de espera.

5. Na segunda etapa das configurações será necessário definir quais as condições das oportunidades para que a ação seja disparada.

2.1. Neste Funil (obrigatório): informe onde a Ação Automática poderá ser realizada;

2.2. Nesta etapa do funil (obrigatório): selecione em qual etapa Ação automática deve ser executada;

 2.3. Com este status e situação (obrigatório):  selecione o Status e Situação que a Oportunidade poderá estar para executar essa Ação;

2.4. Origem das oportunidades: defina a origem das oportunidades para que a ação seja executada;

2.5. Tags das oportunidades, empresas e pessoas: selecione quais tags devem ser atribuídas às oportunidades, empresas ou pessoas para que a ação seja  executada;

2.6. Segmento das empresas: informe qual o segmento a empresa deve estar vinculada para que ação seja executada;

2.7. Neste horário de ativação do gatilho (Opcional): se esta opção estiver ativada, o gatilho só será acionado dentro das faixas de horários indicados. Será necessário configurar as faixas de horários para execução.

Para mais detalhes sobre a primeira parte de configuração das ações automáticas, acesse este artigo.

Para saber mais sobre a personalização de dia e horário para a execução de ações automáticas, acesse este artigo.

Clique em "Próximo".

6. A partir deste ponto, será configurada a segunda parte da ação automática. Informe os seguintes campos: 

  • Header: informação referente à chave que estará contida no cabeçalho, a depender da integração de destino;
  • Valor: valor referente à chave do header;

Dica: é possível informar mais de um header. Para isto, clique em "+ Adicionar header e valor".

  • URL: campo de preenchimento obrigatório. Trata-se do endereço que receberá os dados enviados via webhook do CRM de vendas PipeRun;
  • Tipo de envio: é possível selecionar entre as opções "padrão" e "avançado", conforme abaixo:
    • Padrão: utiliza as chaves padrões do sistema da PipeRun, sem possibilidade de customização;
    • Avançado: possibilita customizar a formatação do JSON de saída dos dados enviados via ação automática. Para saber como customizar as chaves, continue a leitura no próximo tópico ou clique aqui.

Após preencher os campos necessários, clique em "Salvar".


Pronto! Após seguir os passos acima, sua ação automática de enviar para webhook estará configurada. 

CONFIGURANDO A FORMATAÇÃO DE SAÍDA DOS DADOS

Atenção! Para realizar a configuração de formatação de saída dos dados, é necessário ter conhecimentos técnicos prévios em troca de dados entre sistemas.

Para customizar a formatação do JSON de saída dos dados enviados via ação automática, siga o passo a passo abaixo:

1. Em "Tipo de envio", na tela de edição da ação automática, selecione a opção "Avançado".


2. Em "Formatação de saída", selecione a opção "JSON". 

Em breve estaremos disponibilizando outros tipos de formatação de saída. Para sugerir novas funcionalidades utilize nossa plataforma de sugestões.


3. Na área "JSON Disponível" você poderá visualizar a estrutura padrão do JSON enviado via ação automática.

Dica: confira no final do artigo o comentário em código com a descrição das chaves disponíveis no CRM de vendas PipeRun.


4. Já na área central da tela, configure a expressão de saída desejada, seguindo esta estrutura:

Caso de uso: a chave padrão do PipeRun referente ao nome fantasia do registro do contato da empresa é "company" e a chave padrão no sistema que receberá os dados via ação automática é "empresa". Para que a expressão seja recebida da forma correta no sistema de destino, basta configurar a expressão da seguinte forma:

{
"nome-da-chave-de-saída":"nome-da-chave-do-piperun"
}
Desta forma, a formatação do JSON enviado pelo PipeRun terá como chave "empresa", ao invés de "company".
{
  "empresa": "company"
}  



5. Agora, confira a pré-visualização da formatação do JSON de saída, na área direita da tela.


6. Para realizar um teste de envio de dados, basta clicar no botão "Envio de teste", localizado no canto inferior esquerdo da tela.

 

Dica: o envio de teste será realizado para a URL definida na ação automática.

7. Por fim, após finalizar as configurações de saída da ação automática, não esqueça de clicar no botão "Salvar", localizado no canto inferior direito da tela, para registrar a ação.

Dica: é possível ativar os logs temporários da ação automática. Para isto, clique nos logs na listagem de ações automáticas e, após em "Logs temporários". Os logs serão mantidos por 24 horas (após esse período, serão excluídos).

TESTANDO A AÇÃO AUTOMÁTICA VIA BEECEPTOR


Caso necessário, depois de criar a ação automática webhook - enviar oportunidade para URL é possível testar o seu funcionamento.

Neste exemplo, utilizamos o site beeceptor para gerar uma URL gratuita para testar o envio de dados da ação automática.

1. No Beeceptor, digite no campo "Endpoint name" um nome para a URL a ser criada. Neste exemplo utilizamos o nome "piperun1". Logo após, clique em "Create Endpoint".




2. Agora, clique no ícone conforme indicado no print abaixo, para copiar a URL. 

Mantenha o site do Beeceptor aberto. Será necessário retornar à esta tela após a execução da ação automática.

A URL criada seguirá o padrão https://endpointname.free.beeceptor.com. Sendo o endpointname o que valor que você informou conforme o passo 1. Neste  exemplo, a URL gerada foi https://piperun1.free.beeceptor.com.


3. Informe a URL obtida no beeceptor (link do endpoint criado) no campo "URL" das configurações da ação automática. Para saber mais sobre os campos da ação automática, acesse o passo 5 do segundo tópico ou clique aqui. 


4. Acesse o pipeline e execute a ação automática, conforme etapa e gatilho configurados. Neste exemplo, a oportunidade será movida de uma etapa para outra.


5. Após a execução da ação automática, será necessário acessar o site do Beeceptor, onde poderá ser visualizada a requisição recebida. Clique em "POST" para abrir os detalhes da requisição e visualizar seu payload.

O método POST é um tipo de requisição de envio. Isto significa que a URL criada recebeu uma requisição de envio após o acionamento da ação automática.


6. Em "Request body" será exibido o corpo da requisição. Nela, poderemos ver as informações que foram enviadas da oportunidade via ação automática. Observe também que há a informação "200" dentro de uma caixa verde. Isso significa que a requisição possuiu um status 200, ou seja, foi bem sucedida.


7. Teremos um resultado com todas as informações disponíveis da oportunidade, como empresa vinculada à oportunidade, segmento, usuário, telefones, etc. 

Portanto, pode-se concluir que a ação automática está funcionando corretamente. 

Dica:  é possível visualizar todos os registros (logs) de ações automáticas realizadas, em andamento ou que apresentaram falha. Para saber mais, acesse este artigo.

CÓDIGO COM A DESCRIÇÃO DAS CHAVES DISPONÍVEIS

{
  "id": 1234, // ID da oportunidade
  "title": "Oportunidade Exemplo", // Título da oportunidade
  "created_at": "2021-01-01 14:48:02", // Data da criação da oportunidade
  "closed_at": null, // Data de fechamento da oportunidade
  "probably_closed_at": null, // Data de previsão de fechamento da oportunidade
  "last_contact": null, // Data de último contato da oportunidade
  "description": null, // Descrição da oportunidade
  "observation": null, // Observação da oportunidade
  "status": 0, // Status da oportunidade (0 = Aberto / 1 = Ganha / 3 = Perdida)
  "deleted": 0, // Situação Lixeira da oportunidade (0 = Fora da lixeira / 1 = Na lixeira)
  "freezed": 0, // Situação Congelada da oportunidade (0 = Não congelada / 1 = Congelada)
  "frozen_at": null, // Data em que a oportunidade foi congelada
  "value": "0.00", // Valor total da oportunidade em produtos e/ou serviços (P&S)
  "value_mrr": "0.00", // Valor total da oportunidade em recorrência (MRR)
  "hash": "abc123", // Hash da oportunidade (obtida através da exportação)
  "order": 1, // Ordem numérica na listagem da etapa do funil
  "probability": null, // Probabilidade de fechamento da oportunidade
  "updated_at": null, // Data da última alteração da oportunidade
  "stage_changed_at": null, // Data da última mudança de etapa da oportunidade
  "lead_time": null, // Lead time da oportunidade (tempo entre a criação da oportunidade e seu fechamento)
  "temperature": null, // Temperatura da oportunidade (1= Muito quente / 2= Quente / 3= Morna / 4= Fria)
  "lost_reason": { // Motivo de perda da oportunidade
      "id": null, // ID do motivo de perda
    "name": null, // Nome do motivo de perda
    "description": null // Descrição do motivo de perda da oportunidade
  },
  "company": { // Array contendo dados da empresa da oportunidade
      "id": 1234, // ID da empresa
    "ie": null, // Inscrição estadual da empresa
    "name":"abc123", // Nome fantasia da empresa
    "cnpj": null, // CNPJ da empresa
    "hash": "abc123", // Hash única da empresa
    "logo": null,  // Logo da empresa
    "open_at": "2000-01-01", // Data de fundação da empresa
    "country": null, // País da empresa
    "website": null, // Website da empresa
    "email_nf": null, // E-mail para envio de nota fiscal da empresa
    "created_at":"2017-01-01 22:11:59", // Data de cadastro da empresa
    "observation": null, // Observações da empresa
    "company_name": null,  // Razão social da empresa
    "address": { // Array contendo dados de endereço da empres
        "street": null, // Nome da rua do endereço da empresa
      "postal_code": null, // CEP do endereço da empresa
      "number": null, // Número do endereço da empresa
      "complement": null, // Complemento do endereço da empresa
      "district": null // Bairro do endereço da empresa
    },
    "size": null, // Tamanho da empresa
    "cnae": "123", // Codigo do CNAE primário da empresa
    "facebook": null, // URL da página do Facebook da empresa
    "linkedin": null, // URL da página do Linkedin da empresa
    "status_touch": null, // Modelo touch da empresa (1= High touch / 2= Middle touch / 3= Low touch / 4= Tech touch / 5= Now touch)
    "company_situation": "null", // Situação da empresa (1= Lead / 2= Lead Suspect / 3= Lead Qualificado Marketing (MQL) / 4= Lead Qualificado Vendas (SQL) / 5= Lead Aceito Vendas (SAL) / 6= Lead Prospects (OPs) / 7= Cliente ativo / 8= Cliente inativo / 9= Cliente perdido (Churn))
    "city": { // Array contendo dados cidade e estado da empresa
      "id": 1234, // ID da cidade da empresa
      "name": "abc", // Nome da cidade da empresa
      "uf": "abc" // UF da cidade da empresa
    },
    "segment": { // Array contendo os dados do segmento da empresa
      "id": 1234, // ID do segmento da empresa
      "name": "abc", // Nome do segmento da empresa
      "sector": null // Setor do segmento da empresa
    },
    "user": { 
      "id":1234, // ID do usuário
      "name":"abc" // Nome do usuário
    },
    "cnaes": [{ // Array contendo os dados de CNAE da empresa
      "id": 1234, // ID do CNAE da empresa da oportunidade
      "code": "123", // Código do CNAE da empresa da oportunidade
      "description": "abc123" // Descrição do CNAE da empresa da oportunidade
    }],
    "contact_emails": [{ // Array contendo os dados de e-mail da empresa
      "id": 1234, // ID do e-mail de contato da empresa da oportunidade
      "address": "[email protected]" // Endereço do e-mail de contato da empresa da oportunidade
    }],
    "contact_phones": [{ // Array contendo os dados de telefone da empresa
      "id": 1234, // ID do telefone de contato da empresa
      "number": "123" // Número do telefone de contato da empresa
    }],
    "economic_groups": [{ // Array contendo informações do grupo econômico vinculado à empresa
    "id": 123, // ID do grupo econômico vinculado à empresa
    "name": "abc123" // Nome do grupo econômico vinculado à empresa
    }],
    "fields": [{ // Array contendo informações dos campos customizados vinculados a empresa
      "id": 1234, // ID do campo customizado
      "nome": "abc123", // Nome do campo customizado
      "valor": null, // Valor do campo customizado
      "tipo": 1, // Tipo do campo customizado (1= Texto / 3= Única escolha / 5= Texto longo / 6= Múltipla escolha / 7= Chat do Skype / 8= Chamada do Skype / 9= Cadastro de link / 10= Data / 11= Número de WhatsApp / 12= Cidade / 13= Fórmula / 14= Numérico / 15= Upload de arquivo)
      "valores": null 
     }],
      "forms": [] // Formulários vinculados à empresa da oportunidade 
  },
  "person": {
    "id": 1234,  // ID da pessoa de contato vinculada a oportunidade
    "hash": "abc123", // Hash da pessoa vinculada a oportunidade
    "name": "abc123", // Nome da pessoa vinculada a oportunidade
    "cpf": null, // CPF da pessoa vinculada a oportunidade
    "job_title": "abc123", // Cargo da pessoa vinculada a oportunidade
    "rdstation": "URL public do rdstation",  // Link do RDStation da pessoa vinculada a oportunidade
    "birth_day": null, // Data de nascimento da pessoa vinculada a oportunidade
    "gender": null, // Gênero da pessoa vinculada a oportunidade
    "website": null, // URL do website da pessoa vinculada a oportunidade
    "facebook": null, // URL do perfil do Facebook da pessoa vinculada a oportunidade
    "linkedin": null, // URL do perfil do Linkedin da pessoa vinculada a oportunidade
    "avatar": null, // Avatar da pessoa vinculada a oportunidade
    "observation": null, // Observações da pessoa vinculada a oportunidade
    "address": { // Array contendo endereço da pessoa vinculada a oportunidade
      "street": null, // Nome da rua do endereço da pessoa vinculada a oportunidade
      "postal_code": null, // CEP do endereço da pessoa vinculada a oportunidade
      "number": null, // Número do endereço da pessoa vinculada a oportunidade
      "complement": null, // Complemento do endereço da pessoa vinculada a oportunidade
      "district": null // Bairro do endereço da pessoa vinculada a oportunidade
    },
    "company": { // Array contendo os dados da empresa vinculada à pessoa da oportunidade
      "id": 1234, // ID da empresa vinculada a pessoa da oportunidade
      "name": "123", // Nome da empresa vinculada a pessoa da oportunidade
      "cnae": "123", // CNAE da empresa vinculada a pessoa da oportunidade
        "fields": [{ // Array contendo dados do campo customizado
          "id": 1234, // ID do campo customizado
          "nome": "abc123", // Nome do campo customizado
          "valor": "abc123", // Valor do campo customizado
          "tipo": 1, // Tipo do campo customizado (1= Texto / 3= Única escolha / 5= Texto longo / 6= Múltipla escolha / 7= Chat do Skype / 8= Chamada do Skype / 9= Cadastro de link / 10= Data / 11= Número de WhatsApp / 12= Cidade / 13= Fórmula / 14= Numérico / 15= Upload de arquivo)
          "valores": null
      }]
    }
  },
  "tags":[{ // Arrays contendo informações sobre as tags da portunidade
         "id": 1223, // ID da tag
         "name": "abc123", // Nome da tag
         "color": "warning" // Cor da tag
      }
    ],
  "stage": {
      "id": 1234, // ID da etapa do funil da oportunidade
    "name": "abc123" // Nome da etapa do funil da oportunidade
  },
  "pipeline": {
    "id": 1234, // ID do unil em que se encontra a oportunidade
    "name":"abc123" // Nome do funil em que se encontra a oportunidade
  },
  "origin":{ 
    "id": 1234, // ID da origem da oportunidade
    "name": null, // Nome da origem da oportunidade
    "origin":{
      "id": null,  // ID da origem em caso de sub-origem da oportunidade
      "name": null  // Nome da sub-origem da oportunidade
    }
  },
  "user": { 
    "id": 1, // ID do usuário dono da oportunidade
      "name": "abc", // Nome do usuário dono da oportunidade
      "avatar": null // Foto do usuário dono da oportunidade
  },
"involved_users": [
    {
      "id": 123, //ID do usuário envolvido na oportunidade
      "name": "John Doe", //Nome do usuário envolvido na oportunidade
      "email": "[email protected]", //E-mail do usuário envolvido na oportunidade
      "telephone": "(20) 7042-5594", //Telefone do usuário envolvido na oportunidade
      "cellphone": "(73) 9 8586-5687", //celular do usuário envolvido na oportunidade
      "involvement": {
        "deal_involved_role": "teste", //Papel do usuário envolvido na oportunidade
        "proposal_involved_role": "Testador" //Nome do papel na proposta do usuário envolvido na oportunidade
      }
    }
  ],
  "city": {
    "id": null,  // ID da cidade da oportunidade
    "name": null,  // Nome da cidade da oportunidade
    "uf": null  // UF da cidade da oportunidade
  },
  "proposals": [{ // Array contendo informações da proposta
    "id": 123, // ID da proposta
    "hash": "123abc", // Hash da proposta
    "value": "00,00", // Valor da proposta em produtos e/ou serviços (P&S)
    "status": 0, // Status da proposta (0= Aberta / 1= Aprovada / 2= Negada / 3= Cancelada / 4= Aguardando assinatura / 5= Assinada)
    "created_at": "2021-07-14T14:32:39.000000Z", // Data de criação da proposta
    "valid_until": "2021-07-21", // Data de validade da proposta (formato YYYY-MM-DD)
    "payment_method_mrr": null, // Forma de pagamento recorrência (MRR)
    "value_mrr": "0.00", // Valor da proposta em recorrência (MRR)
    "due_date_mrr": null, // Data de vencimento da recorrência (MRR)
    "first_payment_mrr_date": null, // Data do primeiro pagamento da recorrência (MRR)
    "user":{ // Usuário responsável pela proposta
      "id": 1234, // ID do usuário responsável pela proposta
      "name":"xxxxxx" // Nome do usuário responsável pela proposta    
    },
    "shippingCompany": [], // Dados da transportadora
    "billingCompany": [], // Dados da empresa de faturamento
    "triangularCompany": [], // Empresa de entrega triangular
    "brand":{ // Dados da empresa (marca)
      "id":1, // ID da empresa (marca)
      "ie": null, // Inscrição estadual da empresa (marca)
      "name":"abc", // Nome fantasia da empresa (marca)
      "cnpj": null, // CNPJ da empresa (marca)
      "hash": "123abc", // Hash da empresa  (marca)
      "logo": null,  // Logo da empresa  (marca)
      "open_at": "2000-01-01", // Data de fundação da empresa  (marca)
      "website": null, // Website da empresa  (marca)
      "email_nf": null, // E-mail para envio da nota fiscal  (marca)
      "created_at": "2017-01-01 22:11:59", // Data de cadastro da empresa  (marca)
      "observation": null, // Observações da empresa  (marca)
      "company_name": null,  // Razão social da empresa (marca)
      "address":{ // Array contendo dados de endereço da empresa  (marca)
        "street": null, // Nome da rua do endereço da empresa  (marca)
        "postal_code": null, // CEP do endereço da empresa  (marca)
        "number": null, // Número do endereço da empresa  (marca)
        "complement": null, // Complemento do endereço da empresa  (marca)
        "district": null // Bairro do endereço da empresa  (marca)
      },
      "size": null, // Tamanho da empresa  (marca)
      "cnae": "123", // Código do CNAE primário da empresa  (marca)
      "facebook": null, // URL da página do Facebook da empresa  (marca)
      "linkedin": null, // URL da página do Linkedin da empresa  (marca)
      "status_touch": null, // Modelo touch da empresa  (marca) (1= High touch / 2= Middle touch / 3= Low touch / 4= Tech touch / 5= Now touch)
      "company_situation": "Cliente ativo" // Situação da empresa (marca)
    },
    "items": [{
      "id": 1234, // ID do item (P&S / MRR)
      "name": "abc123", // Nome do item (P&S / MRR)
      "reference": null, // Referência do item (P&S / MRR)
      "code": null, // Código do item (P&S / MRR)
      "category": null, // Categoria do item (P&S / MRR)
      "characteristics": [], // Caracteristicas do item (P&S / MRR) na proposta
      "type": 1, // Tipo de item (0= Produto / 1= MRR / 2= Serviço)
      "cost": null, // Custo do item (P&S / MRR) na proposta se não do cadastro
      "value": 1234, // Valor do item (P&S / MRR) na proposta
      "ipi_tax": 1234, // Taxa de IPI aplicada no item (P&S / MRR) na proposta
      "quantity": 1, // Quantidade de itens na proposta
      "discount": 1.5, // Desconto aplicado na proposta para o item (P&S / MRR)
      "commission_final_value": 0, // Valor total de comissão do item (P&S / MRR) na proposta
      "type_of_charge": 2, // Em caso de item do tipo recorrência (MRR), é o tipo de cobrança para pagamento
      "charge_name": "Mensal", // Nome do tipo de cobrança
      "duration": 12, // Em caso de item do tipo recorrência (MRR), duração do produto
      "contract_start_at": null, // Em caso de item do tipo recorrência (MRR), , data de início da duração do contrato
      "contract_end_at": null,// Em caso de item do tipo recorrência (MRR), data final da duração do contrato
      "comissao": null,
      "description": "abc123", // Descrição do item na proposta
      "discount_type": 0, // Tipo de desconto aplicado (0= Percentual / 1= Absoluto)
      "fix_commission_value": null, // Valor absoluto da comissão aplicada
      "commission_incidence_type": 1, // Em caso de item do tipo recorrência (MRR), tipo de incidencia de comissão (1= 1ª mensalidade / 2= 12 primeiras mensalidades / 3= 1ª e última mensalidade / 4= todas as mensalidades)
      "commission_incidence_name": "1ª mensalidade" // Em caso de item do tipo recorrência (MRR), nome de incidência de comissão
      }
    ],
    "parcels": [{ // Arrays contendo as informações das parcelas de produtos e serviços (P&S)
      "id": "00", // ID da parcela de P&S
      "value": "0.0000", // Valor da parcela  de P&S
      "parcel": "0", // Tipo de parcela  de P&S
      "discount": null, // Desconto  de P&S
      "commission_final_value": 0, // Valor total da comissão referente a parcela de P&S
      "due_date": "2018-01-01", // Data de vencimento da parcela  de P&S
      "account_id": "1", // ID da conta
      "proposal_id": "000", // ID da proposta
      "payment_method_type_id": { // ID do tipo de método de pagamento
        "id": "1", // ID do método de pagamento
        "name": "abc" // Nome do método de pagamento
        }
     }],
    "parcels_mrr": [{ // // Arrays contendo as informações das parcelas de recorrência (MRR)
      "id": 894879, // ID da parcela de recorrência (MRR)
      "value": "51.2200", // Valor da parcela de recorrência (MRR)
      "parcel": "1", // Número da parcela de recorrência (MRR)
      "discount": null, // Desconto aplicado na parcela de recorrência (MRR)
      "commission_final_value": "0.00", // Valor real da comissão aplicada na parcela de recorrência (MRR)
      "due_date": "2022-07-28", // Data de vencimento da recorrência (MRR)
      "account_id": 9552, // ID da conta
      "proposal_id": 500597, // ID da proposta
      "payment_method_type_id": { // ID do tipo de método de pagamento
        "id": 11, // ID do método de pagamento
        "name": "PIX" //  Nome do método de pagamento
      }
    }]
  }],
  "activities": [], // Atividades que estão vinculadas a oportunidade
  "files": [],
  "fields": [{// Campos customizados da oportunidade
    "id": 1234, // ID do campo customizado da oportunidade
    "nome": "abc123", // Nome do campo customizado da oportunidade
    "valor": null, // Valor do campo customizado da oportunidade
    "tipo": 6, // Tipo de campo customizado
    "valores":"[\"abc123\",\"abc123\",\"abc123\"]" // Valores utilizados nos campos de seleção
  }],
  "forms": [], // Formulários vinculados com a oportunidade
  "action": { // Dados da ação automática do PipeRun
    "create": "2021-07-13T17:48:06.816034Z", // Data do disparo da ação automática
    "pipeline":"abc123", // Nome do funil que foi disparada a ação automática
    "stage": "Qualquer etapa", // Nome da(s) etapa(s) que foi disparada a ação automática
    "trigger_type": "Uma oportunidade entrar na etapa selecionada", // Tipo de gatilho da ação automática
    "user": null // Usuário que disparou a ação, caso tenha sito disparada manualmente
   }
}

PERGUNTAS FREQUENTES

1. É possível enviar e receber payload pelo webhook no CRM de vendas?

R: Sim, é possível enviar através da ação automática de envio por URL e receber através do integrador Json

Para saber mais sobre o integrador Json, acesse este artigo.

2. É possível enviar o histórico de um lead convertido utilizando a ação automática de envio por Webhook?

R: Não é possível enviar o histórico da oportunidade em si. Entretanto, o sistema permite incluir dados sobre a empresa, a oportunidade e as pessoas relacionadas. Além disso, ao configurar a ação automática no modo “Avançado”, é possível personalizar o JSON de saída com as informações que se deseja enviar.

3. É possível usar um valor fixo em uma variável no webhook que não esteja associado aos campos do Piperun?

R: Sim, é possível sim enviar dados estáticos que não são do CRM PipeRun.

Abaixo irei repassar dois exemplos de como enviar as informações:

I - Envio de String (texto): basta adicionar os parâmetros em aspas duplas e valores em aspas simples (em outros casos, aspas duplas), ficando desta maneira:"fk_journey": '451'

Dica: neste exemplo o valor é repassado como Texto.

II - Envio de Valores Inteiros (e valores com virgula): basta que o valor do parâmetros seja escrito com a crase, ficando da seguinte maneira:"fk_journey": `451`

Dica: neste exemplo, o valor é repassado como valor numérico. 

Em caso de dúvidas, chame nossa equipe no chat. 😉