Documentação

Integrações: webhooks e API

Conecte a Harvis aos seus sistemas internos usando webhooks e a API Enterprise.

Webhooks

Os webhooks permitem que uma URL HTTPS de sua propriedade receba um POST com corpo JSON quando ocorre um evento compatível, por exemplo, relacionado a registros de campo ou a um novo usuário após o onboarding.

Como configurar

  1. Entre no painel como administrador.
  2. Acesse Configurações.
  3. Abra a seção Webhooks.
  4. Crie um webhook: defina um nome, a URL de destino e, se necessário, cabeçalhos HTTP.
  5. Escolha a categoria de evento correspondente ao seu caso de uso e ative o webhook quando estiver pronto para produção.
  6. Se houver a opção de incluir todo o canal, leia a descrição antes de ativá-la: ela amplia o alcance dos eventos.

Recomendações técnicas

  • Responda com um código 2xx em poucos segundos; processe trabalho pesado em segundo plano.
  • Projete o receptor para ser idempotente: novas tentativas podem ocorrer.
  • Valide a identidade com os cabeçalhos configurados na Harvis.
  • Os campos do JSON podem evoluir: versione seu consumidor e seja tolerante a novas propriedades.

Se você não encontrar Webhooks em Configurações, isso pode depender do seu plano ou de flags da empresa: consulte o suporte.

API REST pública

A API Enterprise da Harvis permite consultar dados produtivos, produtores associados, clima, alertas, pedidos e catálogo de produtos com permissões explícitas por integração.

Para integrações em tempo real, use webhooks pelo painel. As chaves API são criadas, rotacionadas e revogadas em Configurações.

Abrir referência da API →

Guias de uso do painel →← Central de documentação

WhatsApp