Pular para o conteúdo principal

Integração Webhook - Configuração

Esta página irá ajudá-lo a configurar a integração webhook com a API GroupLink.

Pré-requisitos​

Importante

Antes de configurar webhooks, certifique-se de ter o SDK GroupLink integrado em seu aplicativo móvel. Sem a integração do SDK, não haverá eventos para enviar ao seu webhook.

  • Acesso à API: Credenciais válidas da API GroupLink
  • Endpoint HTTPS: Um endpoint webhook acessível via HTTPS para receber eventos
  • Entendimento de Eventos: Conhecimento de quais eventos você deseja receber

Informações Necessárias para Configuração​

Para configurar a integração webhook, você precisará fornecer as seguintes informações para a equipe GroupLink:

1. Endpoint Webhook​

Forneça a URL completa do seu endpoint que receberá os eventos:

Exemplo: https://api.yourcompany.com/webhooks/grouplink
Plataformas de Automação

Você pode usar qualquer plataforma de automação ou serviço que suporte webhooks para receber eventos GroupLink. Abaixo estão alguns exemplos populares, mas você não está limitado a eles - qualquer endpoint compatível com HTTPS funcionará.

Como criar um webhook no Zapier:

  1. Crie um novo Zap
  2. Escolha "Webhooks by Zapier" como trigger
  3. Selecione "Catch Hook"
  4. Copie a URL gerada pelo Zapier

Requisitos do Endpoint:

  • Deve ser acessível via HTTPS
  • Deve aceitar requisições POST com content-type application/json
  • Deve responder com status HTTP 2xx (200, 201, 204) para confirmar o recebimento
  • Tempo de resposta recomendado: menos de 1 segundo

2. Identificador da Aplicação​

O package name (identificador único) da sua aplicação:

  • Android: com.yourcompany.yourapp
  • iOS: com.yourcompany.yourapp
Observação

Se você possui aplicações Android e iOS, ambos os package names serão configurados por nossa equipe para iniciar o envio de eventos.

Segurança e Autenticação​

Versão Atual​

O webhook pode ser chamado sem autenticação, mas recomendamos fortemente que você implemente medidas de segurança no seu endpoint para evitar acessos não autorizados.

Autenticação via API Key​

  • A API Key será enviada no header da requisição
  • Header: X-API-Key: your-api-key-here
  • Você pode validar a origem das requisições

Formato das Requisições​

Todas as requisições enviadas ao seu webhook seguirão este padrão:

Método: POST Content-Type: application/json Body: JSON com dados do evento

Exemplos de Eventos por Produto:

Tratamento de Erros e Retentativas​

Comportamento em Caso de Falha​

  • Se seu endpoint retornar erro (4xx or 5xx status), tentaremos reenviar o evento, porém não é garantido que todos os eventos serão reenviados sem perda
  • Número de tentativas: até 3 retentativas
  • Intervalo entre tentativas: 1 minuto, 5 minutos, 15 minutos

Recomendações​

  • Implemente logging adequado no seu endpoint para debug
  • Retorne status 200 o mais rápido possível e processe os eventos de forma assíncrona
  • Implemente idempotência para lidar com possíveis eventos duplicados

Como Solicitar a Configuração​

Para iniciar a configuração do seu webhook, envie um email para suporte@grouplinkone.com com:

Assunto: Configuração Webhook - [Nome da sua empresa]

Corpo do email:

Empresa: [Nome da sua empresa]
Endpoint Webhook: [URL do seu endpoint]
Package Name da Aplicação: [Package name da sua aplicação]
Observaçãos: [Qualquer informação adicional relevante, como por exemplo a forma de autenticação que deseja utilizar no webhook]

Nossa equipe irá processar sua solicitação e confirmar a configuração.

Testando a Integração​

Após a configuração ser concluída pela nossa equipe:

  1. Certifique-se de que seu aplicativo está em execução
  2. Acione os eventos que você configurou
  3. Verifique se os eventos estão sendo recebidos no seu endpoint
  4. Valide a estrutura dos eventos conforme documentado em Dataoris - Exemplos de Eventos Webhook

Próximos Passos​

Suporte​

Se você tiver dúvidas durante a configuração, entre em contato: