Ir para o conteúdo

Dados, API e integrações

Webhooks

Receba uma mensagem assinada no seu próprio endereço quando um cliente é criado, uma ordem muda, uma distribuição é aprovada e mais.

  • Atualizado
  • Para gestores

Quem pode fazer isso: Proprietários e administradores

Eventos

Eventos de webhook
EventoEnviado quando
client.createdUm cliente é adicionado.
order.submittedUma ordem é enviada.
order.approvedUma ordem é aprovada.
order.settledUma ordem é liquidada e as frações são emitidas.
distribution.approvedUma distribuição é aprovada.
transfer.completedUma transferência entre investidores é concluída.
message.receivedUm cliente envia uma mensagem.

Os payloads contêm IDs, números e valores, mas nenhum dado pessoal. Seu sistema busca os detalhes com uma chave de API.

Adicionar um endpoint

  1. Abra Configurações, depois Webhooks, e escolha Adicionar endpoint.
  2. Informe um endereço https que responda com um status 2xx em poucos segundos. Escolha os eventos.
  3. Copie o segredo de assinatura. Ele é mostrado uma única vez.
  4. Escolha Enviar evento de teste para verificar se ele chega.
  • Somente endereços https em hosts públicos são aceitos. Endereços que apontam para redes privadas ou internas são recusados.
  • Redirecionamentos não são seguidos.

Verificar a assinatura

Cada entrega é um POST JSON com os cabeçalhos EasyHaus-Event, EasyHaus-Delivery e EasyHaus-Signature. A assinatura tem o formato t=<unix time>,v1=<hex>. Calcule um HMAC-SHA256 do texto <t>.<raw body> com o seu segredo, compare-o com v1 e rejeite carimbos de data e hora antigos.

O corpo é {id, type, created_at, organization_id, data}.

Novas tentativas e desativação

  • Responda em até 10 segundos. Uma entrega com falha é repetida com intervalos crescentes, em até 10 tentativas.
  • Após 20 falhas seguidas, o endpoint é desativado e os proprietários e administradores recebem um e-mail. Corrija o problema e ative-o novamente, o que zera a contagem.
  • O log de entregas mostra cada entrega, seu status e o código HTTP, e permite reenviar.
  • Você pode editar os eventos, desativar um endpoint, renovar o segredo (o antigo para de funcionar imediatamente) ou excluí-lo.

Não encontrou o que precisa?

Conte o que você estava tentando fazer. Respondemos por e-mail e sua pergunta nos ajuda a escrever o próximo guia. Nunca envie senhas, números de documentos ou dados bancários.