Ir para o conteúdo
PRIMEIRO IMÓVEL GRÁTIS 30 dias de exportação sem marca d’água, sem cartão
Conta e pagamentos

Webhooks: avise seu sistema quando algo muda

Guia: Webhook · · 1 min de leitura

Webhook assinado para o seu endereço quando uma planta é criada ou salva, quando uma exportação fica pronta ou quando um relatório de medição sai.

Para isso você precisa do Pro.

Configurações, API, com Webhooks: o endereço, os eventos e a lista.

Webhook: passo a passo

  1. 1. Abra Configurações, API

    Os Webhooks ficam abaixo das chaves de API. Você precisa ser proprietário ou administrador de um espaço de trabalho com Pro ou Team.

  2. 2. Adicione um webhook

    Digite um endereço https, escolha os eventos e clique em Adicionar webhook. Copie o segredo de assinatura: só mostramos uma vez.

  3. 3. Confira a assinatura

    Toda mensagem tem o cabeçalho Squaremetry-Signature com t (a hora) e v1, o HMAC-SHA256 de "t.body" com o seu segredo. Recuse uma mensagem quando não bater ou quando t tiver mais de 5 minutos. A página para desenvolvedores tem um exemplo.

  4. 4. Ignore duplicadas

    Squaremetry-Event-Id é o mesmo em cada tentativa e em Enviar de novo. Se você já viu o id, responda 200 e não faça nada.

  5. 5. Quando o seu sistema está fora do ar

    Qualquer resposta que não seja 2xx em 10 segundos é tentada de novo depois de 1, 5 e 30 minutos, e depois de 2, 6, 12 e 24 horas. Depois de 8 tentativas desistimos; depois de 20 desistências seguidas, o webhook se desativa sozinho.

  6. 6. Teste, desative, segredo novo

    Enviar mensagem de teste envia um ping. Últimas entregas lista o que foi enviado, com Enviar de novo. Novo segredo troca o segredo na hora. Quando o Pro ou o Team termina, os webhooks ficam Pausados: nada é enviado, e você só pode desativá-los ou removê-los até o plano voltar.

Mensagens que você pode ver

  • Use um endereço que comece com https://.
  • Este endereço está em uma rede privada. Use um endereço público.
  • Desativado após 20 entregas com falha seguidas. Corrija o endereço e ative o webhook de novo.

Veja também

Ainda com dúvida?

Dúvidas sobre “Webhook”? Escreva para nós e conte o que você já tentou. A gente ajuda a partir daí.

Comece a sua primeira planta

Seu primeiro imóvel é grátis por 30 dias, sem cartão. Depois: US$ 5 por imóvel, ou o Pro a partir de US$ 24 por mês.

Comece grátis

ou entre com um código por e-mail