WebHook NF-e e NFC-e

A partir de agora, é possível configurar o envio de notificações via WebHook para os módulos NF-e e NFC-e, sempre que um documento for autorizado pela Sefaz.

Essa nova funcionalidade está disponível para todos os documentos emitidos no sistema e é acionada automaticamente assim que o documento é autorizado pela SEFAZ. O WebHook configurado será notificado, permitindo que o usuário do InvoiCy saiba em tempo real quando a nota fiscal foi autorizada.

A ativação da funcionalidade e configuração do WebHook que receberá as notificações pode ser realizada facilmente pelo Painel de Controle do InvoiCy, na opção “Configurações para Emissão”, nos módulos NF-e e NFC-e. O usuário poderá ativar e desativar a funcionalidade, informar a URL do WebHook, definir o tipo de autenticação e informar o token de autenticação, se for o caso.

Após inserir as informações é possível realizar um teste de comunicação com o Webhook, clicando no botão “Testar Webhook”.

Configuração do WebHook via Web Service

A configuração do WebHook poderá ser realizada também via Web Service. No XML ou JSON de cadastro de empresa existe o Grupo de Campos “Parametros”, onde as configurações são divididas por módulos.

Nos parâmetros dos módulos NF-e e NFC-e foram adicionados novos campos para configurar o WebHook:
– Exemplo via XML

– Exemplo via JSON

Status: O campo Status define se a funcionalidade está ativa ou não, os valores aceitos são: A – Ativo, I – Inativo.

URL: O campo URL é a URL com a qual o InvoiCy irá realizar a requisição POST para enviar a notificação quando o documento for autorizado.

Tipo e Retorno: As informações retornadas pelo InvoiCy serão enviadas no formato JSON. Campo TipoRetorno = 1.

Tipo de Autenticação: O campo Tipo de Autenticação é a forma como o InvoiCy irá se autenticar para realizar a conexão com a URL informada.

Token de Autenticação: Neste campo é parametrizado o Token pelo qual o InvoiCy irá se autorizar/autenticar na API do parceiro em cada requisição.

Com o WebHook configurado e ativo, sempre que um documento for autorizado pela SEFAZ, o InvoiCy irá enviar uma notificação para a URL cadastrada.

Notificação via WebHook para documento autorizado

Quando ocorrer a autorização de um documento, o InvoiCy irá enviar uma notificação ao endereço cadastrado. O conteúdo da notificação será igual ao retorno de uma consulta de documento e irá respeitar o que estiver configurado na tela de “Configurações para Emissão” nos campos “Forma de retorno do PDF na integração” e “Forma de retorno do XML na integração”.

Importante: O serviço que irá receber a notificação do InvoiCy deverá retornar o Status Code 200 ou 201 na requisição enviada pelo InvoiCy, caso contrário, será realizada nova tentativa em 5 minutos. Em caso de falhas sucessivas, o InvoiCy irá abortar o envio da notificação para o respectivo documento.

Em caso de dificuldades para receber as mensagens, o cliente poderá acessar a ferramenta https://webhook.site/ e consequentemente criar uma URL válida que será apontada neste parâmetro.