Documentation

Integrations: webhooks and API

Connect Harvis to your internal systems. You can currently use webhooks from the dashboard; the documented public REST API is still under development.

Webhooks

Webhooks allow an HTTPS URL you own to receive a JSON POST when a supported event occurs, for example, related to field records or a new user after onboarding.

How to configure them

  1. Sign in to the dashboard as an administrator.
  2. Go to Settings.
  3. Open the Webhooks section.
  4. Create a webhook: provide a name, destination URL, and, if needed, HTTP headers.
  5. Choose the event category that matches your use case and enable the webhook when you are ready for production.
  6. If an option to include the whole channel appears, read its description before enabling it: it broadens the events' scope.

Technical recommendations

  • Return a 2xx status within a few seconds; process heavy work in the background.
  • Make the receiver idempotent: retries may occur.
  • Validate identity using the headers you configured in Harvis.
  • JSON fields may evolve: version your consumer and tolerate new properties.

If you do not see Webhooks under Settings, it may depend on your plan or company flags: contact support.

Public REST API

Harvis's public and stable REST API guide—authentication, resources, examples, and limits—is under development. When ready, it will be published in this documentation section.

In the meantime, webhooks from the dashboard are the usual choice for real-time integrations. For enterprise requirements, contact the product or sales team.

Dashboard user guides →← Documentation center

WhatsApp