Introdução

Para receber as notificações é necessário realizar o cadastro via API pública /{loja}​/Inscricao, no qual o request será através de POST para URL (https://) configurada no cadastro que será enviada no formato JSON.

📘

Atenção:

O ideal é ativar a inscrição do webhook, após a finalização da importação dos produtos.

Confira na tabela abaixo os detalhes sobre cada campo do JSON.

Descritivo das nomenclaturas usadas na tabela:

• Campo: identificador do nome do campo;
• Tipo: indica o tipo de dado a ser inserido;
• Nível: identificador do nível do campo na estrutura hierárquica, sendo o nivel = 0 os campos que não estão contidos dentro de arrays e o nível = 1 para os campos contidos em arrays;
• Obrigatoriedade: indica se o envio do campo é obrigatório ou opcional para o sucesso do POST;
• Descrição: corresponde a descrição de um determinado campo e pode ser complementado por uma observação.

Quando o método de criação da inscrição é executado com sucesso, será apresentado no campo "Response Body" o ID da inscrição criada e no campo "Response Code" o ID 201.

📘

Uma dica de utilização do header é o cadastro de autenticação para o acesso a URL fornecido na assinatura.

Você poderá fazer o cadastro do header conforme sua necessidade não existindo nenhuma limitação, com exceção do content-type que será sempre application/json.

No caso de headers para autenticação, a notificação chegará da seguinte forma:

Conforme a imagem acima, os headers cadastrados, usuário e password, chegam no header de conteúdo. Sendo assim, basta capturar essas informações e seguir com a autenticação no sistema de acordo com cada cliente.