Dúvidas frequentes

Essa seção de dúvidas frequentes sobre o webhook, tem o objetivo se clarificar qualquer dúvida que possa aparecer durante seu aprendizado.

O que encontrará no texto?

1. Retorno de um webhook
2. Como saber se o webhook que recebi é da NFE.io
3. Como funciona os headers?

1. Após o cadastro de webhook, o que recebo nas notificações?

• De acordo com o webhook cadastrado, será enviado uma nota fiscal completa (os mesmos dados retornados na consulta da nota fiscal), adicionado dos campos do webhook informados no momento de sua criação.
  Veja como realizar a consulta da nota fiscal.

2. Como saber se o webhook que recebi é da NFE.io?

Disponibilizamos o campo secret para validar que os webhooks que recebe do host da NFE.io são legítimos.

O objetivo é calcular um hash usando seu SECRET_TOKEN e garantir que o hash da NFE.io corresponda. O NFE.io usa um HMAC para calcular o hash.

Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor do HMAC em hexadecimal que será enviado no cabeçalho HTTP X-Hub-Signature. O HMAC será gerado baseado no bytes do evento de notificação que será enviado.

3. Como funciona os Headers?

Caso você precise passar algum campo validador do seu sistema autorizando o nosso sistema enviar notificações.

Exemplo:

Autenticação, disponibilizamos um campo chamado "Header" que poderá ser preenchido de acordo com a sua necessidade. Sendo enviado no momento da criação como "Authorization":

Json para análise dos Headers

{
  "webHook": {

        "insecureSsl": true,
        "contentType": "json",
        "filters": [
            "product_invoice.issued_successfully"
        ],
        "headers": [
            "Authorization": "api-key-test"
        ],
        "uri": "https://webhook.site/3483dade-39b8-445f-8928-95f0c0897c76"
    }
}