O que faz um webhook
Um webhook envia os detalhes de um evento da sua loja para outro lugar no momento em que acontece. Escolhe o evento e o destino:
- API: a Storeep envia os dados do evento para um endereço web (URL) do seu servidor, CRM, cenário Zapier ou Make, ou ferramenta de rastreio de anúncios.
- E-mail: a Storeep envia os dados do evento para um endereço de e-mail, por exemplo para receber um e-mail por cada novo pedido.
Abra Configurações > Webhooks. Precisa da permissão Configurações.
Muitas ferramentas já têm uma aplicação pronta, o que é mais fácil: Google Sheets, redes de transportadoras e píxeis de anúncios. Consulte primeiro o mercado de Aplicações.
Criar um webhook
Clique em Adicionar novo Webhook, preencha o formulário e clique em Adicionar.
- Ativar: marcado por predefinição. Quando está marcado, os eventos são enviados de imediato. Desmarque-o para manter o webhook mas colocá-lo em pausa.
- Nome: uma etiqueta para a sua lista, por exemplo "Novos pedidos CRM".
- Tipo: API ou E-mail.
- Evento:
- Pedido criado: um cliente faz um novo pedido.
- Pedido Atualizado: o estado ou os detalhes de um pedido mudam.
- Sessão criada: um novo visitante chega à sua loja. Só para o tipo API.
- Formato: Json.
- URL (tipo API): o endereço de destino. A parte
https://é adicionada por si, por isso escreva o resto, comoapi.example.com/orders. - Endereço de e-mail (tipo E-mail): para onde vai o e-mail.
Um webhook E-mail só envia eventos de pedidos. Se escolher E-mail com Sessão criada, nada é enviado.
Colocar dados do pedido no URL
Pode colocar qualquer campo dos dados do evento dentro do URL com chavetas duplas, {{field_name}}. Por exemplo:
example.com/postback?cid={{fbclid}}&payout={{order_total}}
Isto envia o ID de clique do Facebook e o total do pedido para uma plataforma de rastreio de anúncios ou de afiliados, sem servidor adicional. Um campo que não existe fica vazio. Para ver os nomes dos campos, crie um webhook E-mail para o mesmo evento e veja os dados que recebe.
A lista de webhooks
Cada linha mostra o Nome, URL / E-mail, Tipo, Evento, Formato e Estado (Ativado ou Desativado). Clique numa linha para a editar. Selecione linhas e escolha Eliminar webhooks para as remover definitivamente. Há um número máximo de webhooks por loja, e vê uma mensagem quando o atinge.
Pode criar vários webhooks para o mesmo evento, por exemplo um para o seu CRM e outro para a sua ferramenta de rastreio de anúncios.
Quando um envio falha
- O seu servidor deve responder depressa com um código de sucesso (2xx). Uma resposta lenta conta como falha.
- Se o seu servidor estiver em baixo ou ocupado (uma resposta 5xx ou 429, ou nenhuma resposta), a Storeep tenta de novo várias vezes nos minutos seguintes. Só os webhooks que falharam são repetidos, para que os outros não recebam duplicados.
- Se o seu servidor recusar o pedido (uma resposta 4xx como 404 ou 403), a Storeep não tenta de novo, porque o endereço ou a sua segurança estão errados.
- Quando um webhook falha várias vezes seguidas, o dono da loja recebe um único e-mail: "Ação necessária: o seu webhook do Storeep está a falhar", com o nome do webhook, o endereço, o evento e o último código de erro. Depois de o webhook voltar a funcionar, um problema futuro pode enviar um novo aviso. Pode desligar este e-mail em Notificações.
- Os webhooks E-mail são enviados uma vez, sem novas tentativas.
Webhooks em pausa por um saldo por pagar
Se a sua loja tiver um valor em dívida por pagar e a sua carteira não o conseguir cobrir, os webhooks ficam à espera. São enviados depois de adicionar fundos e de o valor ser liquidado. Consulte Carteira e faturação.
Dicas
- Se o seu servidor precisar de uma palavra-passe ou chave, coloque-a na query do URL, por exemplo
?key=yoursecret. - Sessão criada dispara para cada visitante, o que pode ser muito numa loja movimentada. Use-o só se o seu servidor aguentar.
- Para deixar uma ferramenta ler os seus pedidos e produtos quando quiser, use antes um token de acesso.