Criando Webhooks

Webhooks fornecem uma maneira poderosa de obter atualizações em tempo real da sua plataforma Awardco, permitindo uma integração perfeita com seus outros aplicativos. Diferente das APIs tradicionais que exigem que você verifique constantemente por novas informações, os webhooks enviam automaticamente os dados para o local especificado assim que um evento relevante ocorre na Awardco. Isso garante que você sempre tenha as informações mais atualizadas, sem atrasos.

Atualmente, nosso recurso de webhooks foca em eventos de Reconhecimento, o que significa que você pode receber instantaneamente dados sobre reconhecimentos conforme eles acontecem na Awardco. Esses dados incluem detalhes como o remetente, destinatário, quantidade de pontos, nota do reconhecimento e o nome do programa. Este artigo irá guiá-lo sobre como criar, configurar e gerenciar webhooks para sincronizar dados de reconhecimento da sua plataforma Awardco para o endpoint escolhido.

1. Casos de Uso de Webhook 
2. Navegando até o Criador de Webhook
3. Criando um Webhook
4. Gerenciando Webhooks
5. Perguntas Frequentes

Caso de Uso de Webhook 

Webhooks permitem que sua organização exiba atualizações de reconhecimento em tempo real em feeds sociais fora da plataforma, como uma intranet corporativa.

Diferente da conexão via chamadas de API de feed, o processo é instantâneo com webhooks. Assim que um reconhecimento é submetido na sua plataforma Awardco, o webhook é acionado e os dados do reconhecimento são imediatamente enviados para o endpoint especificado, permitindo atualizações instantâneas em seus feeds externos.

Navegando até o Criador de Webhook

Para começar a criar e gerenciar webhooks:

1. Faça login na sua plataforma de reconhecimento.
2. Na página inicial, selecione o botão Admin na parte inferior do menu de navegação à esquerda.
3. Selecione “Plataforma”, depois “Integrações” e então “Webhooks” no menu de navegação à esquerda.

Na página de Webhooks, você verá uma lista dos webhooks existentes. Para criar um novo, clique no botão Criar Webhook.

Criando um Webhook

Quando você clicar em "Criar Webhook", aparecerá um modal onde poderá configurar seu novo webhook. Aqui está uma explicação de cada campo:

• Nome: Dê um nome descritivo ao seu webhook. Isso ajudará você a identificá-lo posteriormente, especialmente se tiver múltiplos webhooks.
• Eventos de Disparo: Este menu suspenso atualmente tem uma opção: Reconhecimento Concluído. Isso significa que seu webhook será ativado sempre que um reconhecimento for enviado com sucesso na Awardco. Estamos abertos a adicionar mais tipos de eventos de disparo no futuro com base nas solicitações dos clientes.
• URL do Endpoint: Esta é a URL para onde os dados do reconhecimento serão enviados. Você é responsável por fornecer esta URL. Este é o "local" com o qual seu webhook irá se comunicar.
• Chave Secreta: Esta é uma medida de segurança gerada automaticamente. Quando uma requisição de webhook é enviada da Awardco, você usará esta chave secreta para criar uma assinatura. Esta assinatura é então comparada com uma assinatura enviada pela Awardco. Se coincidirem, verifica que os dados realmente vêm da Awardco e não de um terceiro malicioso. Para detalhes técnicos sobre como gerar essa assinatura, consulte a seção "Verificação de Webhook" na nossa documentação de API.
• Emails para Recebimento de Erros: Se houver algum problema na entrega dos dados do seu webhook, os logs de erro serão enviados para os endereços de e-mail listados aqui. Você pode adicionar múltiplos endereços separando-os por vírgulas.
• Status: Ative esta opção para que os dados do evento sejam entregues quando o evento de disparo ocorrer. Definir como Inativo pausará o webhook.
• Executar Teste: Clique neste botão para enviar dados fictícios de reconhecimento para a URL do endpoint especificada. Isso permite que você verifique se seu webhook está configurado corretamente antes de entrar em funcionamento com dados reais. Lembre-se de excluir quaisquer reconhecimentos de teste que apareçam no seu feed fora da plataforma após executar o teste.

Gerenciando Webhooks

Depois de criar um webhook, você pode gerenciá-lo na página principal de Webhooks. Ao lado de cada webhook, você encontrará um menu de três pontos com as seguintes opções:

• Visualizar Detalhes: Esta opção exibe informações gerais sobre o webhook, incluindo a possibilidade de copiar a chave secreta.
• Editar: Isso o levará de volta ao modal de criação do webhook, onde você pode modificar qualquer configuração do webhook.
• Executar Teste: Semelhante ao botão "Executar Teste" durante a criação, isso envia dados fictícios para sua URL de endpoint para garantir que o webhook está funcionando conforme o esperado.
• Definir como Inativo: Isso pausa o webhook, impedindo que ele seja acionado e envie dados.
• Definir como Ativo: (Visível apenas se o webhook estiver inativo) Isso reativa o webhook, permitindo que ele seja acionado novamente.
• Excluir: Isso remove permanentemente o webhook.

Perguntas Frequentes

• P: Qual a diferença entre webhooks e APIs?
  • R: APIs normalmente requerem que você faça requisições para obter dados. Webhooks, por outro lado, são "orientados a eventos", o que significa que eles enviam automaticamente dados para o endpoint especificado assim que um evento particular (como o envio de um reconhecimento) ocorre. Isso torna os webhooks ideais para atualizações em tempo real.
• P: Posso ter webhooks para eventos além de "Reconhecimento Concluído"?
  • R: Atualmente, "Reconhecimento Concluído" é o único evento de disparo disponível. Estamos explorando adicionar mais tipos de eventos no futuro. Se você tiver um caso de uso específico, por favor, entre em contato com seu ponto de contato na Awardco. 
• P: Onde posso encontrar mais documentação técnica sobre webhooks?
  • R: Nossa documentação de API inclui uma seção dedicada a webhooks, que fornece mais detalhes técnicos, incluindo informações sobre como gerar uma assinatura a partir da sua chave secreta para verificação do webhook. Enquanto estiver em beta, esta página pode ser acessada diretamente em: https://api.awardco.com/api/webhooks

If you have any questions, please contact Awardco Admin Support.