Como configurar webhooks da loja

Um webhook é um aviso automático que a loja manda para o endereço de outro sistema quando algo acontece, como um pedido pago ou um estoque alterado. Assim o seu ERP ou automação não precisa ficar perguntando à loja o tempo todo. Cada aviso é assinado, para o sistema de destino ter certeza de que veio da sua loja. A tela é do administrador.

Antes de começar

• Tenha a URL do sistema que vai receber os avisos. Ela precisa começar com https, ser de um domínio público e usar as portas 443 ou 8443.
• O sistema de destino precisa responder rápido e confirmar o recebimento. Quem configura isso costuma ser o fornecedor do sistema ou um desenvolvedor.

Passo a passo

1. 1

   Abra a aba Webhooks

   Em Configurações > API e webhooks, clique em Webhooks. O topo mostra quantos endereços estão cadastrados (até 10).

2. 2

   Clique em Novo webhook

   Clique em Novo webhook.

3. 3

   Informe a URL

   Em URL do endpoint, cole o endereço do seu sistema. Em Descrição (opcional), anote para que serve.

4. 4

   Escolha os eventos

   Em Eventos, marque o que deve gerar aviso. Vem marcado Pedido pago.

5. 5

   Decida sobre dados pessoais

   Marque Incluir dados pessoais dos clientes só se o sistema de destino precisar de nome, e-mail, telefone, CPF e endereço (por exemplo, para emitir nota ou etiqueta).

6. 6

   Crie

   Clique em Criar webhook.

7. 7

   Guarde o segredo

   O segredo de assinatura aparece uma única vez. Copie, guarde e configure no seu sistema para ele conferir as assinaturas. Depois clique em Já guardei, fechar.

8. 8

   Teste

   No cartão do webhook, clique em Enviar teste. O painel mostra se o seu servidor respondeu e em quanto tempo.

Os eventos disponíveis

• Pedidos: Pedido criado, Pedido pago, Status do pedido alterado e Pedido cancelado.
• Produtos: Produto criado, Produto atualizado e Estoque alterado.
• Clientes: Cliente novo.

Acompanhar e manter

• Entregas: abre o histórico de envios daquele webhook, com status Entregue, Nova tentativa, Enviando, Falhou ou Cancelada. Em cada entrega, Reenviar manda de novo.
• Editar: muda URL, descrição, eventos e dados pessoais. Clique em Salvar.
• Desativar e Reativar: pausam e retomam os avisos.
• Novo segredo: gera outro segredo. O atual para de valer na hora, então atualize o seu sistema logo em seguida.
• Excluir: apaga o webhook, as entregas pendentes e o histórico.