Desenvolvedores

Webhooks

Cada notificação gerada pela sua conta pode ser enviada diretamente para seus próprios sistemas como um JSON POST assinado — assim, o que acontece na sua hospedagem pode iniciar um fluxo de trabalho em qualquer outro lugar.

O que você pode conectar a ele

Um webhook é uma solicitação HTTPS comum, portanto, qualquer coisa que possa receber uma pode agir com base nela. Você não precisa que criemos uma integração para sua ferramenta.

Plataformas de automação

Aponte um webhook para um fluxo de trabalho em n8n, Make, Zapier, Pipedream, Activepieces e cada evento se torna um gatilho — publique em um canal, abra um chamado, atualize uma planilha, chame outra API. Plataformas auto-hospedadas funcionam exatamente da mesma maneira, desde que o endpoint seja acessível via HTTPS.

CRMs e centrais de ajuda

Envie eventos de cobrança e de conta para HubSpot, Pipedrive, Salesforce, ou para qualquer helpdesk ou CRM com um webhook de entrada, para que o registro do cliente reflita o que a hospedagem dele está fazendo sem que ninguém precise copiar isso manualmente.

Qualquer outra coisa que escute

Slack, Discord, Google Sheets, Airtable, Notion, seu próprio monitoramento, um data warehouse ou um pequeno script que você escreveu. Se puder aceitar um POST HTTPS e ler JSON, poderá recebê-los.

O que é enviado

Você escolhe quais categorias vão para qual destino — e pode conectar várias, para que a cobrança vá para um lugar e os alertas do site para outro. Tudo vem ativado por padrão.

Faturamento e pagamentos

Faturas emitidas e pagas, pagamentos que falharam, cartões prestes a expirar, renovações e cancelamentos.

Sites e segurança

Provisionamento concluído, um site suspenso, malware encontrado, backups e alterações de certificados.

Suporte e domínios

Tickets abertos e escalados, transferências de domínios, renovações e alterações de DNS.

Comprovando que uma solicitação veio de nós

Cada solicitação é assinada com um segredo que apenas você e nós possuímos. Verifique a assinatura antes de agir com base no corpo — estes cabeçalhos chegam com cada entrega:

X-Zinn-Signature: sha256=<hmac of `timestamp.body`>
X-Zinn-Timestamp: unix seconds
X-Zinn-Delivery: stable id for this delivery
X-Zinn-Event: invoice.paid

O carimbo de data/hora é assinado junto com o corpo em vez de ser enviado ao lado dele, para que uma requisição capturada por alguém não possa ser reenviada contra você mais tarde. Rejeite qualquer coisa com mais de alguns minutos.

O seu segredo de assinatura é exibido apenas uma vez, quando você adiciona o webhook. Não podemos exibi-lo novamente — se você o perder, remova o destino e adicione-o novamente.

Configurando um

No seu painel, abra Notificações e adicione um destino do tipo Webhook.
Forneça a ela o seu endpoint HTTPS e copie o segredo de assinatura que exibimos para você.
Pressione Testar. Enviamos uma solicitação real no mesmo formato de uma solicitação ativa, para que você possa programar com base nela antes que qualquer coisa real aconteça.
Escolha quais categorias esse destino deve receber. Novos tipos de notificação são ativados automaticamente.

Você pode adicionar quantos destinos quiser, misturar webhooks com e-mail, Slack e Telegram, e atribuir a cada um um conjunto diferente de categorias.

Prefere nos ligar?

Os webhooks informam quando algo aconteceu. A API é como você faz algo acontecer — todas as operações que o painel realiza estão disponíveis para você.

Explorar a referência da API