Webhooks são gatilhos que podem ser configurados para notificar um outro sistema de mudanças ocorrido em algum recurso, reduzindo o retrabalho de ter que ficar comparando duas bases de dados constantemente.
Dica! Os Webhooks de Contratos e Medições autorizados e desautorizados podem auxiliar a ter o conhecimento exato de quando um contrato ou medição foi autorizado ou ficou pendente.
Nesse artigo serão apresentados os momentos em que cada Webhook é disparado, pois existem situações em que o Webhook não é disparado devido a regras e comportamentos internos do Sienge.
Webhooks de Autorizações de Contratos
O fluxo de autorização de contratos possui variações no funcionamento quando o sistema está configurado para uso de “Aprovação Final” portanto, destacamos aqui o comportamento nos dois cenários (com e sem o uso de aprovação final).
Sem uso de Aprovação Final
"CONTRACT_AUTHORIZED": Sempre que um contrato consistente é totalmente autorizado, ou seja, não é notificado a cada autorização de alçada, mas somente quando não restam autorizações pendentes.
- Não notifica ao criar o contrato;
- Notifica ao autorizar totalmente um contrato nas alçadas de autorização;
- Notifica ao autorizar um contrato ao salvar um item de contrato, seja na edição ou em aditivos;
- Notifica ao autorizar um contrato ao incluir um item de contrato, seja na edição ou em aditivos;
- Notifica ao autorizar um contrato ao excluir um item de contrato, seja na edição ou em aditivos;
- Não notifica salvamentos posteriores nos 3 casos acima quando o contrato já está autorizado e continua autorizado.
"CONTRACT_UNAUTHORIZED": Sempre que um contrato consistente é desautorizado.
- Não notifica ao criar o contrato;
- Notifica ao desautorizar um contrato ao salvar um item de contrato, seja na edição ou em aditivos;
- Notifica ao desautorizar um contrato ao incluir um item de contrato, seja na edição ou em aditivos;
- Notifica ao desautorizar um contrato ao excluir um item de contrato, seja na edição ou em aditivos;
- Notifica salvamentos posteriores nos 3 casos acima quando o contrato já está desautorizado e continua desautorizado;
- Não notifica quando o contrato é reprovado, pois apenas ocorre a inclusão do estado de "reprovação" no contrato;
- Não notifica quando está reprovado e há atualização apenas na aba "Cadastro" do contrato, pois nesse caso apenas ocorre a remoção do estado de "reprovação" no contrato.
Com o uso de Aprovação Final
"CONTRACT_AUTHORIZED": Sempre que um contrato consistente é totalmente autorizado, ou seja, não é notificado a cada autorização de alçada, mas somente quando não restam autorizações pendentes.
- Não notifica ao criar o contrato;
- Notifica ao autorizar totalmente um contrato nas alçadas de autorização, nesse caso, na alçada de aprovação final;
"CONTRACT_UNAUTHORIZED": Sempre que um contrato consistente é desautorizado.
- Não notifica ao criar o contrato;
- Notifica ao desautorizar um contrato ao salvar um item de contrato, seja na edição ou em aditivos;
- Notifica ao desautorizar um contrato ao incluir um item de contrato, seja na edição ou em aditivos;
- Notifica ao desautorizar um contrato ao excluir um item de contrato, seja na edição ou em aditivos;
- Não notifica salvamentos posteriores nos 3 casos acima quando o contrato já está desautorizado e continua desautorizado;
- Não notifica quando o contrato é reprovado;
- Não notifica quando está reprovado e há atualização apenas na aba "Cadastro" do contrato, pois nesse caso apenas ocorre a remoção do estado de "reprovação" no contrato.
Webhooks de Autorizações de Medições
"MEASUREMENT_AUTHORIZED": Sempre que uma medição consistente é totalmente autorizada.
- Notifica ao criar a medição (caso o parâmetro 284 esteja configurado como “Consistentes”);
- Notifica ao autorizar totalmente uma medição nas alçadas de autorização;
- Notifica ao autorizar uma medição através do salvamento da aba de cadastro da medição;
- Notifica ao autorizar uma medição através do salvamento da aba de itens medidos na medição;
- Não notifica salvamentos posteriores nos 2 casos acima quando a medição já está autorizada e continua autorizada.
"MEASUREMENT_UNAUTHORIZED": Sempre que uma medição consistente é desautorizada.
- Notifica ao criar a medição (caso o parâmetro 284 esteja configurado como “Consistentes”);
- Notifica ao desautorizar uma medição através do salvamento da aba de cadastro da medição quando ela estava autorizada, ou seja, não notifica salvamentos posteriores quando a medição já está desautorizada e continua desautorizada;
- Notifica ao desautorizar uma medição através do salvamento da aba de itens medidos na medição, quando ela estava autorizada, ou seja, não notifica salvamentos posteriores quando a medição já está desautorizada e continua desautorizada;
- Não notifica ao reprovar a medição;
- Notifica ao desautorizar uma medição através do salvamento da aba de cadastro da medição quando ela está reprovada;
- Notifica ao desautorizar uma medição através do salvamento da aba de itens medidos na medição quando ela está reprovada.
Quais clientes podem utilizar APIs/Webhooks e quais recursos do sistema estão disponíveis? Clientes DC tem disponível os recursos de APIs. Para os clientes com servidor local o acesso de APIs não está disponível.
Para saber mais sobre a disponibilidade e planos acesse Quais clientes podem utilizar APIs e Quais recursos do sistema estão disponíveis? : Sienge Plataforma
Para entender mais sobre o que é uma Webhook, acesse: O que são APIs REST, BULK e Webhooks?
Esperamos que este artigo tenha ajudado!