Polyosync Help Center

Como podemos ajudar?

Consulte os artigos ou entre em contato com o suporte.

Solicitar suporte

Como configuro um webhook para uma integração externa?

Configurar um webhook permite que um aplicativo externo envie informações sobre eventos para um sistema receptor, desde que a funcionalidade de webhook necessária seja suportada. A configuração do webhook varia entre os provedores e pode exigir configurações técnicas, como URLs de endpoint, credenciais de autenticação, assinaturas de eventos e formatos de payload. Antes de configurar um webhook Certifique-se de entender: 1. Qual aplicativo gera o evento. 2. Qual evento deve iniciar a operação. 3. Qual sistema receberá o webhook. 4. Quais informações o webhook conterá. 5. Como o sistema receptor autentica a solicitação. 6. Qual ação deve ocorrer após o recebimento do evento. Como preparar uma conexão webhook Passo 1: Identifique a fonte do evento. Determine qual aplicativo externo gerará o webhook. Passo 2: Revise a documentação do provedor. Confirme que o provedor suporta o evento necessário e o método de entrega do webhook. Passo 3: Identifique o endpoint receptor. Um webhook requer uma URL de destino válida. Se o seu fluxo de trabalho pretendido exigir que o Polyosync receba o evento, verifique se um endpoint de webhook de entrada suportado está disponível para essa configuração. Não substitua uma URL geral do site do Polyosync por um endpoint de webhook dedicado. Passo 4: Configure a autenticação. Onde suportado, configure o segredo de assinatura necessário, o método de autorização ou outro mecanismo de verificação. Passo 5: Selecione os tipos de eventos. Inscreva-se apenas em eventos relevantes para o processo de negócios pretendido. Passo 6: Revise o payload. Identifique os campos que serão entregues e determine quais informações são necessárias. Passo 7: Configure a operação de recebimento. Onde suportado, conecte o evento de entrada à lógica de processamento ou fluxo de trabalho de negócios apropriado. Passo 8: Envie um evento de teste. Use a funcionalidade de teste do provedor, se disponível. Passo 9: Valide o resultado. Confirme que a solicitação chega ao endpoint correto e produz o resultado esperado. Passo 10: Revise o tratamento de erros. Determine como as entregas com falha, eventos duplicados e solicitações inválidas devem ser tratadas. O que é um endpoint webhook? Um endpoint webhook é uma URL projetada para receber solicitações HTTP de outro aplicativo. O sistema receptor deve implementar o manuseio e a validação de solicitações necessárias. Posso usar qualquer URL como um endpoint webhook? Não. O destino deve suportar o método de solicitação esperado, o formato do payload, o mecanismo de autenticação e o comportamento de processamento. Como sei se um webhook foi entregue? Muitos provedores oferecem logs de entrega ou históricos de eventos. Onde disponível, inspecione o status da resposta HTTP, o tempo de entrega e as informações de erro. Uma entrega bem-sucedida significa que todo o fluxo de trabalho foi bem-sucedido? Não necessariamente. Uma resposta HTTP bem-sucedida pode confirmar o recebimento sem confirmar a conclusão de cada operação de negócios subsequente. O que acontece quando um evento é enviado duas vezes? Alguns provedores tentam a entrega novamente. O processo receptor deve ser projetado para evitar ações duplicadas não intencionais. Recomendações de segurança Use HTTPS, valide as solicitações recebidas, proteja os segredos de assinatura e rejeite eventos não autorizados. Nunca exponha credenciais de webhook em documentação pública ou capturas de tela. Abordagem recomendada Teste o webhook com um único tipo de evento antes de introduzir eventos adicionais ou ações críticas para os negócios. Verifique todo o processo desde a geração do evento até o resultado final do negócio.