Trevo — Central de ajuda

Aparência

Automações

Em uma frase ​

Uma automação é uma integração que você configura: quando algo acontece no Trevo, ela manda os dados que você escolheu para um endereço web ou por e-mail; ou, no sentido contrário, deixa um sistema seu pedir ao Trevo que rode um cálculo ou sincronize um conector.

Como funciona ​

Você escolhe um de quatro gatilhos. Três enviam dados para fora: Cálculo finalizado, Cálculo aprovado e Plano de remuneração alterado. O quarto, Requisição recebida, recebe pedidos de fora. Para os que enviam dados, você escolhe os campos num catálogo próprio de cada gatilho. Só automações ativas disparam, e toda automação nasce ativa.

Plano específico ou todos os planos ​

Você pode ligar a automação a um plano de remuneração ou deixá-la valer para todos os planos. No gatilho de plano alterado, marque ao menos uma ação entre criado, editado e excluído. "Criado" só está disponível com "todos os planos".

Quando cada gatilho dispara ​

Cálculo finalizado dispara só na execução oficial, nunca na simulação. Se o plano tem avaliação de pagamento, o envio acontece quando ela termina, já com o que foi liberado. Você escolhe entre dois modos:

  • por pessoa remunerada: um envio para cada pessoa, com o total dela;
  • por cálculo (lote): um único envio por execução, com os dados gerais e uma lista com cada pessoa. O total a pagar é a soma dos totais das pessoas. Se você não escolher, a automação fica neste modo.

Cálculo aprovado faz um envio por pessoa quando a remuneração dela é aprovada, inclusive pelo Painel do vendedor. Só aqui existem os campos Aprovado em e Aprovado por.

Plano alterado envia o resumo do plano: nome, descrição, fonte de dados, filtros, itens, quem alterou e quando. A lista do que mudou só vem preenchida na edição.

O que vai em cada envio ​

Tipo, identificação e data do evento vão sempre, mesmo sem você selecionar. Escolha ao menos um campo além desses.

Para cada campo, você define o caminho de saída: onde ele aparece no conteúdo enviado. Use pontos para criar níveis (pagamento.total) e, em cada pedaço, só letras, números, _ e -. Dois campos não podem ter o mesmo caminho, e um caminho não pode ser o começo de outro (a e a.b juntos). No lote, o caminho dos campos de pessoa vale dentro de cada item da lista pessoas_remuneradas.

Com um plano escolhido, os gatilhos de cálculo oferecem as Variáveis do plano: cada item do plano vira um campo com o valor dele para a pessoa. Item sem valor vai vazio. Os valores são sempre em real, e o e-mail da pessoa só vem se ela estiver cadastrada em Pessoas remuneradas.

Destino ​

  • Endereço web: precisa ser https e acessível pela internet, com envio do tipo POST, PUT ou PATCH. A autenticação pode ser nenhuma, bearer, API key, basic ou uma credencial salva. Todo envio leva o cabeçalho X-Trevo-Gatilho com o tipo do gatilho.
  • E-mail: informe ao menos um destinatário. Sem assunto, o assunto vira o nome do gatilho.

Ao trocar o endereço web de uma automação, informe a credencial de novo. Se você remover uma credencial salva, as automações que a usam são desativadas; troque a credencial para reativá-las.

Envio, reenvio e histórico ​

O conteúdo de cada envio é fixado no momento do evento. Mudar os campos depois não altera envios pendentes, mas mudar o destino, sim. Desativar ou excluir a automação cancela o que estava pendente.

Se o endereço não responder com sucesso em até 10 segundos, o Trevo tenta de novo em 30 segundos, 2 minutos e 10 minutos. Depois da quarta falha, o envio fica como falha. O histórico da automação mostra cada tentativa, com o código de resposta e, nas falhas, a resposta do seu sistema.

Testar ​

O botão de teste faz um envio real para o seu destino, com valores de exemplo, usando o que está na tela mesmo sem salvar. Ele não entra no histórico. Você pode testar até 5 vezes por minuto, e a empresa até 60 vezes por hora.

Requisição recebida ​

Essa automação executa o cálculo de um plano ou sincroniza um conector, à sua escolha. Você define um código (letras minúsculas, números e hífen) e o Trevo gera uma chave secreta. Guarde a chave: ela aparece inteira uma única vez. Se perder, gere outra, e a anterior deixa de funcionar.

Seu sistema chama o endereço da automação com a chave no cabeçalho X-Trevo-Chave. Para executar o cálculo, o conteúdo deve ser exatamente {"competencia": "AAAA-MM"}; para sincronizar, {}. Qualquer campo a mais ou a menos recusa a chamada. Cada automação aceita até 60 chamadas por minuto.

Se o plano já está calculando ou o conector já está sincronizando, a chamada é recusada por conflito e nada é iniciado. Se for recusada sem motivo, confira a chave, o código, se a automação está ativa e se o plano ou conector ainda existe. O histórico de requisições mostra cada chamada e a situação do que ela disparou.

Exemplo completo ​

Você cria uma automação "Cálculo finalizado" para o plano "Vendas", em lote, com o total a pagar e, de cada pessoa, nome e total. Na execução oficial de março, Ana fica com R$ 1.200, Bruno com R$ 800 e Carla com R$ 500. O Trevo faz um único envio com os três na lista e total a pagar de R$ 2.500. No modo por pessoa remunerada, seriam três envios, de R$ 1.200, R$ 800 e R$ 500.

Perguntas frequentes ​

Simulei e nada foi enviado. Por quê? Os gatilhos de cálculo só disparam na execução oficial.

Mudei os campos, mas um envio saiu com os antigos. O conteúdo é fixado quando o evento acontece. Os próximos eventos já usam a configuração nova.

Perdi a chave da requisição recebida. Gere uma nova e atualize seu sistema; a antiga deixa de valer.

Meu sistema ficou fora do ar. Perdi o envio? O Trevo tenta até 4 vezes em cerca de 12 minutos. Se todas falharem, o envio aparece como falha no histórico.

Veja também ​