Pular para o conteúdo
  • Não há sugestões porque o campo de pesquisa está em branco.

Como configurar Apphooks

Receba notificações de eventos específicos dos seus clientes a partir dos webhooks da Appmax.

Você pode receber notificações de diversos eventos utilizando Apphooks, os webhooks da Appmax. Para acessar a tela e criar um novo Apphook, basta seguir estes passos:

  1. Selecione Configurações, no menu lateral esquerdo.

  2. Clique em Apphooks (Webhook).

  3. Selecione o botão roxo Novo Webhook.

Desta forma, você abrirá o menu de criação de um novo Apphook. Depois, basta seguir estes passos:

  1. Selecione a loja cadastrada que receberá as notificações.

  2. Insira a URL para Envio que será realizada a requisição quando ocorrer os eventos selecionados.

  3. Selecione os eventos que deseja receber notificações.

  4. Escolha um dos templates de como o conteúdo JSON será enviado.

A seleção de eventos está separada em 4 grupos: Cliente, Pedido, Pagamento Não Autorizado e Assinatura.

Para eventos na categoria Pedido, você pode selecionar regras de disparo por SKU (código do produto) ou por valor total do pedido.

Abaixo, detalhamos cada um dos eventos que podem ser selecionados:

Cliente

  • Cliente Criado: Ocorre no momento em que o cliente é cadastrado no sistema. Utilizando o Checkout da Appmax, o cliente é cadastrado sem os dados de endereço, sendo depois atualizado com essas informações. No caso de um produto digital, os dados de endereço são opcionais, de forma que podem não ser cadastrados.

  • Cliente interessado (60min): É o evento de abandono de carrinho. O envio ocorre 60 minutos após o cadastro do cliente e somente se o cliente não efetuou nenhum pedido durante esse período. Esse cliente ainda pode ser convertido na atuação do AppCall e passar a ter um pedido.

  • Cliente Contatado: Ocorre quando o cliente interessado é atendido.

Pedido

  • Pedido aprovado: Ocorre toda vez que um pedido tem seu status alterado para aprovado, tanto pedidos de cartão de crédito quanto de boleto que já passaram e foram aprovados na análise antifraude.

  • Pedido autorizado: Esse evento acontece logo após a autorização da transação de cartão de crédito pela adquirente. Assim que isto ocorre, o status do pedido é atualizado para Autorizado.

  • Boleto Gerado: Toda vez que um cliente gera um boleto, esse evento é disparado. No corpo da requisição são enviados o link para visualização do boleto e a data de vencimento do mesmo.

  • Pedido Pago: Evento disparado tanto no momento da autorização quando na mudança para status Aprovado. Esse evento é recomendado para receber a notificação no momento do pagamento, sem esperar o resultado da análise de fraude.

  • Pedido Pendente de Integração: Esse evento ocorre quando há alguma pendência no pedido impedindo que ele mude seu status para Integrado. Isso pode ocorrer devido a um problema na validação dos dados (CEP inconsistente com os dados de endereço informados, por exemplo). Para mais informações, acesse este artigo.

  • Pedido Estornado: Quando o pedido é estornado, seja por fraude após a análise manual ou pela aprovação de uma solicitação de um reembolso, esse evento é disparado.

  • Upsell Pago: No caso de um pedido ter um upsell de um clique, onde o cliente aceite aumentar seu pedido pelo botão de upsell, esse evento é disparado. Para saber como configurar um upsell de 1 clique, acesse este artigo.

  • Pix Gerado: Evento disparado no momento em que a chave pix é gerada para o cliente realizar o pagamento de sua compra.

  • Pix Pago: Evento disparado no momento em que a chave pix é paga.

  • Pedido Integrado: Evento disparado quando o pedido muda para o status Integrado. Essa é a última etapa de um pedido aprovado no fluxo do sistema. Esse deve ser o status/evento utilizado para emissões de Notas Fiscais e envio de pedidos, pois este evento é disparado após todas as validações.

  • Pedido com Boleto Vencido: Ocorre quando o boleto atinge sua data de vencimento. Possui o mesmo conteúdo do evento de OrderBilletCreated.

  • Pedido Autorizado com Atraso (60min): Mesmo conteúdo do evento de OrderAuthorized, porém com delay de 60 minutos após o momento da autorização.

Pagamento Não Autorizado

  • Pagamento não autorizado: Quando uma transação de cartão de crédito não é aprovada, esse evento é disparado. Acompanha junto ao evento a razão da negativa do pagamento.

  • Pagamento Não Autorizado com Atraso (60min): Mesmo conteúdo do evento de PaymentNotAuthorized, porém com delay de 60 minutos após o momento da negativa.

Assinatura

  • Assinatura cancelada: Quando um pagamento recorrente (assinatura) é cancelado, este evento é disparado.

  • Assinatura atrasada: Quando um pagamento recorrente (assinatura) está atrasado, este evento é disparado.

Após selecionar os eventos, o último passo para configuração dos Apphooks é a escolha do template de como o conteúdo JSON será enviado. Você pode selecionar uma destas três opções:

  • Modelo padrão (Recomendado: JSON com as principais variáveis necessárias.

  • Modelo com dois Níveis: JSON aninhando os níveis. Ex: { valor : { total :10} } se torna {valor_total :10}

  • Modelo padrão com Meta: JSON com as principais variáveis e com o rastreio de parâmetros da URL do checkout Appmax.

Depois disso, você pode selecionar Testar Eventos para enviar um teste para a URL cadastrada, ou Salvar seu Apphook.