Enviar eventos para o seu próprio sistema com webhooks

Um webhook permite que o IDup chame um endereço web seu no momento em que algo acontece, por exemplo, quando uma fatura é paga. Cada entrega é assinada e repetida se o seu sistema não responder.

Adicionar um endpoint

1. Abrir o Webhooks separador e pressione Adicionar endpoint.
2. Introduzir um Nome e o URL. Deve ser publicamente acessível. Endereços dentro de uma rede privada são recusados por razões de segurança.
3. Assinale o Eventos o que desejar.
4. Opcional: escolha um Chave de API. O endpoint então recebe apenas eventos que esta chave pode ler.
5. Imprensa Guardar. O IDup mostra O seu segredo de assinatura uma vez. Armazene-o em segurança.

Eventos

• Fatura criada, Fatura paga, Pagamento recebido
• Novo cliente, Novo contacto, Novo lead, Novo bilhete
• Orçamento aceite — um orçamento que um cliente aceitou

Cada entrega tem três cabeçalhos: o nome do evento, um número de entrega e a assinatura. Uma nova tentativa mantém o mesmo número de entrega, para que o seu sistema possa reconhecer duplicados.

Verificar a assinatura

O seu sistema deve calcular um HMAC-SHA256 sobre o tempo e o corpo bruto com o seu segredo, compará-lo com a assinatura e recusar um tempo superior a 5 minutos. Pressione Verificar assinatura e exemplos para código pronto.

Testar, pausar e renovar

• Enviar teste envia um evento de teste e mostra o código HTTP e o tempo que levou.
• Pausa interrompe as entregas; Ativar reinicia-os.
• Segredo de rotação cria um novo segredo. O antigo deixa de funcionar imediatamente.
• Eliminar remove o endpoint. O seu log é mantido.

Repetições e o registo

O seu endereço deve responder com um código 2xx dentro de 5 segundos. Redirecionamentos não são seguidos. Se falhar, o IDup tenta novamente após 1 minuto, 5 minutos, 30 minutos, 2 horas e 12 horas. Após a sexta tentativa, a entrega é marcada Desistiu.

O log mostra cada tentativa com evento, endpoint, tentativa, código HTTP, duração e o início da resposta. O status é A aguardar, Entregue, Falhou ou Desistiu. Use Reenviar para enviar uma entrega novamente.