Guia de Integrações: Webhooks
Os Webhooks permitem que seus sistemas corporativos sejam notificados, em tempo real, quando ações importantes acontecem dentro do seu ambiente YouDeserve.
Como configurar passo a passo
Para registrar um novo webhook, faça login como Administrador, navegue até Configurações > Integrações e selecione a aba Webhooks. Em seguida, preencha os seguintes dados no formulário:
URL do Webhook (Obrigatório): Insira o endereço de endpoint completo (ex:
https://seu-sistema.com.br/api/webhookou a URL do seu n8n/Zapier) que receberá as requisições POST enviadas pela YouDeserve. A URL deve ser válida e incluir o protocolo HTTP ou HTTPS.Eventos (Obrigatório): Selecione na lista quais eventos irão acionar o disparo de dados para esta URL. Você pode escolher múltiplos eventos em uma mesma configuração (ex: assinar todos os eventos de "Resgates" juntos). É recomendável marcar apenas os eventos que sua aplicação realmente precisa processar, para evitar tráfego de rede desnecessário.
Clique no botão Adicionar Webhook para salvar e ativar a integração instantaneamente.
⚠️ Aviso Importante de Segurança: Ao criar o webhook com sucesso, será exibido um alerta na tela contendo o seu Webhook Secret. Essa chave secreta existe para que sua aplicação possa validar a assinatura criptográfica (HMAC-SHA256) enviada no cabeçalho x-youdeserve-signature de cada requisição. Isso garante que o pacote de dados partiu legitimamente da YouDeserve. Copie e guarde esse segredo imediatamente, pois ele não será exibido novamente no painel após você fechar o aviso!
Você pode excluir webhooks que não são mais necessários a qualquer momento clicando no ícone de lixeira vermelha na lista de webhooks ativos.
Eventos Suportados
Reconhecimentos
recognition.created: Novo reconhecimento foi criado e aguarda revisão (se aprovação automática estiver desativada).
recognition.approved: Reconhecimento pendente foi aprovado pelo gestor.
recognition.reproved: Reconhecimento pendente foi reprovado pelo gestor.
recognition.sent: Reconhecimento foi enviado e ficou visível.
recognition.commented: Um usuário comentou em um reconhecimento aprovado.
recognition.liked: Um usuário curtiu um reconhecimento aprovado.
recognition.highlighted: Um reconhecimento foi destacado.
Recompensas e Resgates
reward.user.is_favorite_changed: Recompensa favoritada ou desfavoritada por um usuário.
reward.order.ordered: Novo resgate de recompensa solicitado (Pendente).
reward.order.approved: Resgate aprovado pelo revisor.
reward.order.reproved: Resgate reprovado pelo revisor.
reward.order.processing: O resgate da recompensa iniciou o processamento para entrega.
reward.order.delivered: A recompensa foi enviada/entregue ao colaborador.
reward.order.chargeback: O resgate falhou externamente.
Outros
deposit.sent: Um depósito de créditos foi enviado/realizado.
notification.in_app.created: Uma notificação no aplicativo foi gerada.
notification.email.sent: Uma notificação por e-mail foi disparada.
notification.push.sent: Uma notificação Push foi enviada.