Os webhooks são os endpoints de retorno de informações geradas no RoutEasy para plataformas externas. Os webhooks são configurados para cada filial, então, caso tenha mais de uma filial apontando para o mesmo webhook, este deverá ser configurado em todas as filiais que o utilizam.
Para acessar a configuração dos webhooks, no menu preto do lado esquerdo, clique no nome da sua Company, depois, vá em Filiais, e clique nos 3 pontos ao lado da filial para a qual deseja configurar o webhook.
Acesse a sua Company -> Filiais -> 3 pontos na linha da filial -> Configurações
Depois, vá em Webhook, e lá poderão ser incluídos os webhooks, tanto para o envio da version, quanto para o envio dos eventos da gestão de entregas.
Página de configuração dos webhooks.
Webhook de exportação da roteirização
Para cadastrar um webhook, clicar em "Criar novo Webhook", escolher o tipo, preencher a URL, e, caso necessário, os headers como pares key value.
Tipos de webhook de roteirização:
- RoutEasy: exportação no formato padrão da RoutEasy (Objeto Version), com paradas consolidadas, ou seja, caso haja uma consolidação, os pedidos dentro do consolidado serão representados por um pedido único dentro de "results.routes.delivery_order", o restante será apresentado em "routing.data.services".
- RoutEasy v3: exportação no formato padrão da RoutEasy (Objeto Version), com paradas desconsolidadas, ou seja, caso haja uma consolidação, os pedidos dentro do consolidado estarão presentes todos dentro de "results.routes.delivery_order"
- ESL: exportação no formato ESL
Webhook de eventos
Pode-se escolher, também, quais são os eventos que vão disparar envios de informações da gestão de entregas do RoutEasy para a sua plataforma.
Para enviar um evento, basta deixar o botão ligado.
Assim como a exportação da roteirização, para cadastrar um webhook de evento, basta selecionar o tipo, preencher a URL, e, caso necessário, os headers como pares key value.
Tipos de webhook de eventos:
- RoutEasy: formato padrão de integração RoutEasy para eventos de Rota e Serviços.
- Magento: Formato utilizado para quem utiliza o Magento 2.
- Tivit: Formato utilizado para quem possui integração com a Tivit.
- Intelipost: Formato utilizado para quem possui integração com a Intelipost.
- SSW: Formato utilizado para quem possui integração com a SSW (necessário realizar a configuração do token previamente e solicitar o cadastro do programa EDI 'SSW2269 - WebAPI de Recepção de Ocorrências de Parceiro' junto a SSW).
- ESL: Formato utilizado para quem possui integração com a ESL.