Como Cadastrar, Consultar, Listar, Editar e Excluir um WebHook

Como Cadastrar, Consultar, Listar, Editar e Excluir um WebHook

Nesse tutorial você entenderá como cadastrar, consultar, listar, editar e excluir WebHook de maneira fácil, simples e intuitiva.

Ao final desse tutorial, você será capaz de:

1. Consultar tipos de eventos
2. Cadastrar um webhook
3. Consultar um webhook
4. Editar um webhook
5. Excluir um webhook
6. Listar todos webhooks

Tutorial

A partir desse momento faremos uma breve explicação de como realizar a integração de WebHooks com a API oferecida pela NFE.io.

Veja mais sobre a Documentação da API

Você pode realizar a importação da url no Postman para ter todos os seguintes exemplos através do link:

https://www.getpostman.com/collections/e0ddf9363c66efd43bc8

Tutorial de como importar a url no postman Clique aqui

Primeiros passos

Antes de tudo, você precisará realizar um cadastro na nossa plataforma app.nfe.io. Depois, você terá que pegar a chave de autorização do nosso sistema.

Devemos atentar para copiar a autorização referente 'Nota fiscal'

Veja como pegar a chave de autorização na plataforma: Autenticação

Lembre-se: Após importar a url do postman e copiar a chave de autenticação para nota fiscal eletrônica, você deverá adicionar em cada requisição na aba "Headers" (cabeçalhos) a chave em "Authorization" (autorização).Lembre-se: Após importar a url do postman e copiar a chave de autenticação para nota fiscal eletrônica, você deverá adicionar em cada requisição na aba "Headers" (cabeçalhos) a chave em "Authorization" (autorização).

WebHook

1. Tipos de Eventos

Para começar a ser notificado pelo WebHoook precisamos identificar quais os eventos possíveis na nossa plataforma. Para isso, precisamos realizar uma chamada no /eventTypes

O método HTTP utilizada na requisição é o "GET", portanto, verifique no seu postman se está preenchido corretamente.

GET: https://api.nfse.io/v2/webhooks/eventTypes

Clicar no botão "Send" (Enviar) para completar a requisição.

WebHook_eventos

Será retornado os eventos disponíveis na plataforma.

WebHook_result

2. Cadastrar

Agora, vamos cadastrar um WebHook.

Para auxiliar nos testes, utilizaremos um gerador de webhook, neste caso, você poderá utilizar qualquer site de webhooks da sua preferência. Caso não tenha um, te indicamos: http://webhook.site

PS: A NFE.io não tem nenhum vínculo com este gerador de WebHook

Atenção: A URI indicada na requição será validada no momento da criação e atualização.

O método HTTP utilizado para cadastrar um webhook é o "POST", portanto, verifique no seu postman se está preenchido corretamente.
(Utilize o Create WebHook na coleção)

POST: https://api.nfse.io/v2/webhooks

Clicar no botão "Send" (Enviar) para completar a requisição.

Será retornado os dados do webhook contendo o identificador deste webhook no campo id.
Ao final do envio, você poderá verificar no gerador de webhooks uma notificação.

3. Consultar

No passo anterior, vimos como criar um webhook.

Faremos agora a consulta do webhook criado a partir da id gerada anteriormente, substituindo-o no campo {webhookId} da request.

O método HTTP utilizado para a consulta de um webhook é "GET", portanto, verifique no seu postman se está preenchido corretamente.
(Utilize o Get WebHook na coleção)

GET: https://api.nfse.io/v2/webhooks/{webhookId}

Clicar no botão "Send" (Enviar) para completar a requisição.
Será retornado os dados do webhook.

4. Editar

Quando precisamos editar algum dado do webhook, trocar a uri por exemplo, utilizamos da seguinte forma.

Faremos agora a edição do webhook criado a partir da id gerada anteriormente, substituindo-o no campo {webhookId} da request.

O método HTTP utilizado para editar um webhook é "PUT", portanto, verifique no seu postman se está preenchido corretamente.
(Utilize o Update WebHook na coleção)

Atenção: A URI indicada na requição será validada no momento da criação e atualização.

PUT: https://api.nfse.io/v2/webhooks/{webhookId}

Clicar no botão "Send" (Enviar) para completar a requisição.

{
"webHook": {
    "insecureSsl": true,
    "contentType": "json",
    "filters": [
        "consumer_invoice.cancelled_error"
    ],
    "uri": "https://nova.url.com"
}
}

Será retornado os dados do webhook editado.

5. Excluir

Para remover um webhook criado, precisamos da id gerada anteriormente, substituindo-o no campo {webhookId} da request.

O método HTTP utilizado para excluir um webhook é "DELETE", portanto, verifique no seu postman se está preenchido corretamente.
(Utilize o Delete WebHook na coleção)

DELETE: https://api.nfse.io/v2/webhooks/{webhookId}

Clicar no botão "Send" (Enviar) para completar a requisição.
Será retornado o Status "200 OK" ao sucesso do cancelamento.

6. Listar

Para listar todos os webhooks, apenas será necessário realizar a request de consulta sem passar nenhuma informação adicional na request.

O método HTTP utilizado para excluir um webhook é "GET", portanto, verifique no seu postman se está preenchido corretamente.
(Utilize o List All WebHooks na coleção)

GET: https://api.nfse.io/v2/webhooks