Pré-requisito(s): acesso ao Painel Intelipost (TMS).

Ferramenta(s): TMS (https://www.intelipost.com.br/).

Webhook é uma forma de recebimento de informações, que são passadas de uma plataforma a outra quando um evento acontece.

Através da tela regras de eventos do Painel da Intelipost (TMS) é possível criar regras que enviam notificações, tanto para o seu e-commerce quanto para a plataforma de cada transportadora, a medida que as atualizações de eventos de rastreamento dos pedidos acontecem, ou seja, conforme os status dos pedidos mudam.

Esse artigo mostra como criar uma regra de evento para disparar notificações, via webhook, a medida que os pedidos recebem determinados status (como em trânsito, falha na entrega, etc). Você pode usar essa funcionalidade para atualizar o status dos pedidos no seu e-commerce, por exemplo.

Também é possível criar regras de evento para enviar um webhook para a plataforma da transportadora, mas só possível inserir uma transportadora por regra de evento criada. Portanto, se houverem mais transportadoras, será necessário criar uma regra de evento para cada uma.
​

Caso queira saber mais sobre a nossa documentação técnica, bem como realizar testes em nossa API, acesse esse link.

1. Acesse a tela regras de eventos no TMS. Para isso, siga o seguinte caminho:
​Menu > Entregas > Configuração > Regras de eventos

2. Clique em adicionar nova regra.

3. Insira o nome, o período de validade da regra e selecione para qual tipo de pedido você deseja aplicar essa regra. Insira um nome que facilite na identificação da regra. O campo período de validade não é obrigatório, portanto, se você deixar esse campo vazio a regra permanecerá ativa até que você a desative manualmente.

4. No campo selecionar condições, selecione a opção evento entrando.

5. No campo adicionar ação, selecione a opção webhook.

6. Ao selecionar a opção webhook, um menu denominado notificação por #Webhook-0 irá aparecer. Escolha se a notificação será enviada por pedido ou por volume (a melhor prática é enviar notificações por pedido, pois um pedido pode ter mais de um volume) e deixe a chave "habilitar?" marcada como sim.

7. Preencha os campos protocolo, host, path, porta e formato de autenticação com os dados da URL plataforma que você deseja enviar o webhook. Caso você queira testar o funcionamento da regra em um site de teste, você pode utilizar este site que cria uma URL de teste e simula o envio de HTTP request. Os campos usuário e senha são opcionais.

8. Escolha, no campo enviar para, para quem a notificação deverá ser enviada (cliente, nesse caso, é sinônimo de embarcador).

9. Ao final dessa janela, na seção evento entrando, escolha para quais status a notificação deverá ser enviada. Você pode configurar o envio de notificações de acordo com o macro ou micro status dos pedidos.
Para configurar para quais status a notificação deverá ser enviada, selecione qual o tipo de status (clicando em macro ou em micro) e clique em cima de cada status que você deseja inserir na regra. Os status inseridos irão aparecer no lado direito da tela, na seção selecionados. Para apagar um status selecionado, basta clicar no x ao lado do status desejado.

Utilizando macro status:

Utilizando micro status:

10. Ao finalizar, clique em salvar.