É possível configurar webhooks para sincronizar dados de vendas e assinaturas entre o Guru e aplicativos externos. Esse recurso pode ser utilizado para enviar dados para o seu app ou sistema próprio.

Nas configurações do admin do Guru, seção “Webhooks”, você pode adicionar webhooks e ajustar as regras de envio, tais como: URL de destino, status para envio, produtos ou Marketplaces aos quais deseja associar o webhook e o número de envios simultâneos.

Como funciona o webhook

Quando uma venda ou assinatura é atualizada, o Guru envia1 uma requisição do tipo POST para a URL configurada contendo todos os dados relacionados ao elemento que sofreu a alteração.

Os dados são enviados em formato JSON e devem ser lidos e interpretados corretamente pela aplicação de destino. Consulte a documentação para desenvolvedores para saber mais.

O webhook apenas envia as informações. O sistema ou aplicação de destino é responsável por interpretar e tomar as ações necessárias de acordo com as informações recebidas no post.

Podem ocorrer vários envios de uma mesma venda ou assinatura mesmo que o status não tenha sido alterado, pois a mesma pode sofrer diferentes atualizações vindas do processador de pagamento.

(1) Para ser enviado, o webhook deve estar ativo e as condições configuradas devem ser atendidas.

Nessa página:

  • Tipos de Webhooks

  • Adicionar webhook

    • Adicionar webhook sobre uma assinatura

    • Adicionar webhook sobre uma venda


Antes de começar, você precisa…

  • Ser usuário administrador ou ter permissão para realizar as ações a seguir.

Tipos de Webhooks

É possível enviar webhooks a respeito de uma assinatura ou de uma venda.

Webhooks sobre uma Assinatura

Você pode usar o webhook de assinaturas (cobranças recorrentes) para receber uma notificação no sistema de destino toda vez que a assinatura for atualizada e esta atender as condições configuradas no webhook.

Essa função é útil quando você precisa tomar uma ação1 conforme o status da assinatura em questão, por exemplo: quando a assinatura for ativada, é necessário liberar o acesso do cliente no seu aplicativo.

A seguir você encontra a lista de tipos (gatilhos) de envio do webhook de assinaturas:

Tipo

Enviado quando…

Ativa

A assinatura foi atualizada e possui o status ativa.

Atrasada

A assinatura foi atualizada e possui o status atrasada.

Cancelada

A assinatura foi atualizada e possui o status cancelada.

Expirada

A assinatura foi atualizada e possui o status expirada.

Inativa

A assinatura foi atualizada e possui o status inativa.

Iniciada

A assinatura foi atualizada e possui o status iniciada.

Trial

A assinatura foi atualizada e possui o status trial (teste gratuito).

(1) O webhook do Guru apenas envia as informações da assinatura. O sistema ou aplicação de destino é responsável por interpretar e tomar as ações necessárias de acordo com as informações recebidas no post.

Webhooks sobre uma Venda (pedido)

Você pode usar o webhook de vendas para receber uma notificação no sistema de destino toda vez que a venda for atualizada e esta atender as condições configuradas no webhook.

Essa função é útil quando você precisa tomar uma ação1 conforme o status da venda em questão, por exemplo: se a venda está cancelada (cartão não-aprovado), seu time de recuperação de vendas deve contactar o cliente.

A seguir você encontra a lista de tipos (gatilhos) de envio do webhook de vendas:

Tipo

Enviado quando…

Abandonada

A venda foi atualizada e possui o status abandonada

Aguardando Pagamento

A venda foi atualizada e possui o status ag pagamento

Aprovada

A venda foi atualizada e possui o status aprovado

Atrasada

A venda foi atualizada e possui o status atrasada

Bloqueada

A venda foi atualizada e possui o status bloqueada

Boleto Impresso

A venda foi atualizada e possui o status boleto impresso

Cancelada

A venda foi atualizada e possui o status cancelada

Completo

A venda foi atualizada e possui o status completa

Em análise

A venda foi atualizada e possui o status em análise

Em Recuperação

A venda foi atualizada e possui o status Em recuperação

Expirada

A venda foi atualizada e possui o status aprovado

Reclamada

A venda foi atualizada e possui o status reclamada

Reembolsada

A venda foi atualizada e possui o status reembolsada

Reembolso Sol.

A venda foi atualizada e possui o status Reembolso Sol.

Rejeitada

A venda foi atualizada e possui o status rejeitada.

Trial

A venda foi atualizada e possui o status trial.

(1) O webhook do Guru apenas envia as informações da venda. O sistema ou aplicação de destino é responsável por interpretar e tomar as ações necessárias de acordo com as informações recebidas no post.

Adicionar Webhook

Você pode configurar webhooks no admin do Guru através das seguintes operações: adicionar, atualizar, desativar e remover. Todas as ações efetuadas são registradas pela plataforma e podem ser consultadas na seção Auditoria.

Consulte o limite de integrações1 ativas (categoria webhooks) para o plano contratado. Caso tenha atingido o limite disponível, basta realizar um upgrade para a categoria Plus 2 ou Plus 3.

(1) Durante o período de testes, é permitido um máximo de 2 webhooks ativos.

1 - De acordo com o tipo de webhook que pretende configurar:

1.1 - sobre uma Assinatura: acesse o menu Configurações » Webhooks e clique em Assinaturas.

1.2 - sobre uma Venda: acesse o menu Configurações » Webhooks e clique em Vendas.

2 - Passe o mouse por cima do Menu de Ações e clique em Adicionar.

3 - Em Detalhe, preencha as informações:

Dados Básicos

  1. Nome: nome do seu webhook.

  2. URL: url de destino obtida no sistema em questão (ou com o desenvolvedor responsável).

  3. Status: para quais status (da venda ou assinatura) o envio do webhook deve ser realizado - você pode selecionar mais de um.

Filtragem de Registros

No caso do webhook de vendas, você deve indicar os tipos de registros que devem ser enviados pelo webhook.

  1. Filtrar por: indique se desejar filtrar por Produtos ou Marketplaces (sistema de pagamento).

  2. Produto ou Marketplace: marque as opções desejadas - se deseja enviar todos, marque a opção Selecionar Todos .

Somente as vendas que atendem aos critérios de filtragem indicados serão enviadas pelo webhook.

Regras de Envio:

  1. Envios Simultâneos: número máximo de envios simultâneos que o Guru deve realizar - indique um valor adequado a fim de evitar sobrecarregar o servidor de destino.

  2. Ativo: mude o botão para a posição ligado.

4 - Clique em Enviar.

A partir deste momento, cada venda ou assinatura atualizada que atender aos critérios definidos será enviada para a URL de destino.

(1) Se necessário, você pode fazer o envio manual de uma venda ou assinatura já existente para o webhook em questão.

Mais Recursos