O webhook faz a INK avisar outro sistema no momento em que algo acontece na sua loja, em vez de esse sistema ficar perguntando de tempo em tempo. Você informa um endereço, escolhe os eventos e a INK envia os dados para lá a cada acontecimento.
O webhook está disponível apenas no plano Inkrível.
Como cadastrar
-
No seu painel, clique em Credenciais de Webhook.
-
Cadastre um novo webhook.
-
Informe o endereço que vai receber os avisos. É um endereço do sistema ou da automação do outro lado, não um site seu.
-
Escolha o método de envio. Quem montou o outro lado sabe qual usar.
-
Informe um código secreto, se quiser. Ele não é obrigatório, mas é o que permite ao seu sistema confirmar que o aviso veio mesmo da INK e não de outra pessoa que descobriu o endereço. Se a integração aceitar, use.
-
Defina o status.
-
Marque os eventos que você quer acompanhar. Eles aparecem agrupados por assunto, e você pode marcar vários de uma vez.
-
Salve.
Cada evento marcado vira um webhook separado na lista, todos com o mesmo endereço, método, status e código secreto. Marcar seis eventos cria seis webhooks. Isso é o esperado, não é erro.
Os eventos disponíveis
São 15 eventos hoje. Cada aviso chega com os dados daquele acontecimento.
Pedido e pagamento
-
Pedido criado no checkout
-
Pagamento confirmado, com a forma de pagamento, a previsão de entrega, a transportadora e o seu lucro no pedido
-
Cartão não autorizado pela operadora
-
Pix ou boleto expirado
-
Pedido cancelado ou reembolsado
Entrega
-
Pedido produzido, aguardando envio
-
Pedido despachado
-
Pedido em trânsito
-
Pedido saiu para entrega
-
Pedido entregue
-
Falha na entrega
Alterações no pedido
-
Itens alterados na janela de 2 horas, com o item anterior, o item novo e quem alterou
-
Endereço de entrega alterado, com o endereço anterior, o novo, quem alterou e quando
-
Pedido com produto personalizado parado há mais de 24 horas, com os itens pendentes e a ação necessária
Carrinho
- Carrinho abandonado, com os itens que ficaram no carrinho
Os eventos de pedido valem também para os pedidos que entram pelas suas integrações de loja, não só para os do checkout da INK.
O carrinho abandonado funciona diferente dos outros. Em vez de um aviso só, ele avisa em quatro momentos, 30 minutos, 8 horas, 16 horas e 24 horas depois do abandono, e cada aviso informa em qual desses momentos ele está. Cada momento é enviado uma única vez por carrinho, e se a compra for concluída os avisos seguintes não são enviados. Isso serve para montar uma régua de recuperação com mensagens diferentes em vez de um disparo único.
O que exatamente vem em cada aviso, em que formato e como confirmar a origem com o código secreto está no portal de documentação, em developers.reserva.ink.
Como gerenciar depois
Na lista você vê todos os webhooks cadastrados, com endereço e evento. Abrindo um deles, dá para alterar o endereço, o método, o código secreto e o status.
Na edição, cada webhook está ligado a um evento só. Ou seja: você marca vários eventos na criação, mas ajusta um por um depois. Para acompanhar um evento novo, cadastre outro webhook com o mesmo endereço.
Os dois erros mais comuns
Salvar sem marcar nenhum evento. O cadastro não é criado e a tela avisa. Volte e marque pelo menos um.
Repetir um evento que já existe no mesmo endereço. Se qualquer um dos eventos marcados já estiver cadastrado naquele endereço, nenhum dos outros é criado e a tela avisa que o endereço já está em uso. Confira na lista o que você já tem antes de cadastrar de novo, e marque só os eventos que faltam.
Antes de sair do painel
Peça para quem montou o outro lado confirmar que os avisos estão chegando. O cadastro no painel garante que a INK vai enviar, não que o sistema do outro lado está recebendo e entendendo. Vale testar com um evento fácil de provocar, como um pedido de teste, antes de contar com o fluxo.