Melhores práticas

1. Serviços para testes com Webhooks

Sugerimos a utilização de um serviço para realização de testes com Webhooks que servem para inspecionar as requisições HTTP. Você pode criar uma URL temporária e usá-la como sua URL do Webhook. Ela irá gravar as solicitações HTTP e permitir inspecioná-las para verificar Headers e Body das requisições. Desta forma, você poderá começar a desenvolver sua integração mesmo se ainda não tiver uma URL pública disponível.

• http://webhook.site
• https://ngrok.com - Requisição externa chega no computador do desenvolvedor.

2. Responda com HTTP Status Code 200

Responda a requisição do Webhook com uma resposta HTTP 200 OK. Qualquer resposta fora do intervalo 2XX informará que você não recebeu seu webhook, incluindo o 301 Redirect. A plataforma Clicksign não segue redirecionamentos para notificações do webhook e considerará um redirecionamento como uma resposta de erro.

Principais erros:

• Requisições HTTP redirecionando para HTTPS.
• Certificados SSL vencidos ou inválidos.

3. Responda rapidamente

Recomendamos que sua aplicação responda o mais rápido possível aos Webhooks da Clicksign. Se você precisar realizar outras requisições ou processamentos dos documentos, realize esses procedimentos em background.

4. Utilize o Header "Event"

Se você precisar filtrar os tipos de eventos recebidos, faça um filtro através do Request Header "Event". Esta é a melhor maneira de buscar qual o tipo de evento, já que para realizar uma busca dentro do Body é necessário realizar primeiramente o parse do JSON.

5. Siga as dicas de segurança

Siga as práticas de segurança disponíveis em Segurança de Webhooks, tanto para proteção do seu end-point, como para verificação da integridade das informações recebidas através do HMAC.

6. Suporte da Clicksign

Se você estiver com problemas relacionados a Webhooks, entre em contato conosco através do e-mail [email protected] com o máximo de detalhes possível. Informações que nos ajudam a debugar a sua requisição:

- Ambiente: sandbox ou produção
- Conta
- URL do Webhook
- E-mail do operador
- Key do documento
- Evento
- Horário da requisição