O que os webhooks fazem
Um webhook é uma assinatura de um evento específico da loja. Quando esse evento ocorre, o Storeep envia imediatamente os dados do evento para uma URL que você especifica (tipo API) ou para um endereço de e-mail que você especifica (tipo E-mail). Os webhooks são comumente usados para integrações de rastreamento de pedidos, sincronizações de CRM, conversões de plataformas de anúncios e notificações automatizadas.
Para gerenciar webhooks, vá para Configurações → Webhooks.
Limites de webhooks
- Máximo de 20 webhooks por loja. Tentar adicionar um 21º retorna um erro.
- Os webhooks são listados do mais recente para o mais antigo, paginados em 40 por página.
Criando um webhook
Clique em Adicionar novo webhook.
Botão Ativar
Quando marcado (o padrão), o webhook fica ativo no momento em que é salvo. Os eventos são enviados imediatamente. Desmarque para salvar o webhook em estado desabilitado sem receber eventos. Você pode ativar ou desativar um webhook a qualquer momento editando-o.
Nome
- Obrigatório.
- Máximo de 50 caracteres.
- Um rótulo descritivo mostrado na lista de webhooks. Exemplo: Facebook CAPI, pedido criado.
Tipo
Controla como o payload do evento é entregue. Duas opções:
- API: o Storeep envia uma solicitação HTTP POST com os dados do evento para a URL que você especificar.
- E-mail: o Storeep envia um e-mail com os dados do evento para o endereço que você especificar.
Evento
O evento da loja que aciona este webhook. Três eventos estão disponíveis:
- Sessão criada: disparado quando uma nova sessão de visitante é criada na sua loja.
- Pedido criado: disparado quando um novo pedido é feito.
- Pedido atualizado: disparado quando o status ou os dados de um pedido existente mudam.
Formato
O formato de dados do payload do evento. Atualmente uma opção:
- Json: o payload é enviado como um documento JSON.
URL (somente tipo API)
- Obrigatório quando o tipo é API.
- Máximo de 500 caracteres. O limite maior acomoda URLs que incluem vários segmentos de espaço reservado.
- Insira a URL do endpoint sem o prefixo
https://. Ele é adicionado automaticamente. Exemplo:api.example.com/events/order. - Espaços reservados dinâmicos na URL: qualquer campo do payload do evento pode ser injetado na URL usando a sintaxe de chaves duplas:
{{field_name}}. Por exemplo:https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
Isso permite enviar dados de conversão para plataformas de anúncios diretamente da URL do webhook sem um servidor proxy separado. - Se a estrutura da URL for inválida após a resolução dos espaços reservados, você receberá um erro de validação.
Endereço de e-mail (somente tipo e-mail)
- Obrigatório quando o tipo é E-mail.
- Deve ser um endereço de e-mail válido, máximo de 127 caracteres.
Editando um webhook
Clique em qualquer linha de webhook para abrir o editor. Todos os campos são editáveis. O campo de URL é pré-preenchido apenas se o tipo atual for API; o campo de e-mail é pré-preenchido apenas se o tipo atual for E-mail. Trocar o tipo limpa o outro campo.
Habilitando e desabilitando webhooks
A caixa de seleção Ativar no topo do editor controla se o webhook dispara. O status na lista mostra Ativado ou Desativado. Um webhook desabilitado não registra entregas, mas não é excluído, para que você possa reativá-lo mais tarde sem reconfigurar.
Colunas da lista de webhooks
- Nome: rótulo do webhook com data de criação.
- URL / E-mail: o endereço de destino.
- Tipo: API ou E-mail.
- Evento: o nome do evento (Sessão criada, Pedido criado ou Pedido atualizado).
- Formato: Json.
- Status: Ativado ou Desativado.
Excluindo um webhook
Selecione um ou mais webhooks e clique em Excluir webhooks. Isso é permanente e interrompe todas as entregas futuras para aquela assinatura.
Dicas e problemas comuns
- Você pode criar vários webhooks para o mesmo evento, por exemplo, enviar Pedido criado para um CRM e para uma plataforma de anúncios, cada um como uma entrada de webhook separada.
- Se o seu endpoint exigir autenticação, adicione as credenciais à query string da URL usando um
{{placeholder}}fornecido pelos dados do evento, ou configure um servidor proxy que lida com a autenticação antes de encaminhar para o endpoint real. - O evento Sessão criada dispara para cada sessão única de visitante, o que pode ter alto volume em lojas populares. Assine-o apenas se o seu endpoint puder lidar com a taxa de transferência.