Skip to main content

Public API & Webhooks: developer resources

Connect Harvestr to your code with the Public API and webhooks. Push and pull data, and react to events in real time.

Written by Marina Salmon

Harvestr exposes its data and events to your code through a Public REST API and webhooks. Use them to build custom integrations, sync data with internal systems, automate workflows beyond what the built-in integrations cover, or react to events the moment they happen.

Public API

The Harvestr Public API gives you programmatic access to your workspace data — feedback, discoveries, components, customers, and more. Common use cases:

  • Push feedback into Harvestr from sources we don't yet have a native integration for.

  • Pull discovery and feedback data into your internal dashboards or BI tools.

  • Build custom workflows on top of Harvestr.

Full documentation — authentication, endpoint reference, and code samples — lives at developers.harvestr.io.

To generate an API key, go to your personal settings in Harvestr and copy your personal access token.

Webhooks

Webhooks send HTTP POST requests with a JSON payload to a URL of your choice whenever specific events happen in your Harvestr workspace. Use them to react to changes in real time — for example, triggering a Slack alert when new feedback comes in, syncing discovery status to an external roadmap, or piping events into a custom analytics pipeline.

Available events

Event

Triggered when

message_created

New feedback arrives in your inbox.

message_updated

Feedback in your inbox is updated.

discovery_created

A new discovery is created.

discovery_updated

A discovery is updated.

component_created

A new component is created.

component_updated

A component is updated.

feedback_created

Feedback is linked to a discovery.

feedback_updated

Feedback linked to a discovery is updated.

Set up a webhook

  1. Go to Settings → Integrations → Harvestr Webhooks.

  2. Click Add a new webhook to organization.

  3. Enter your endpoint URL. It must use HTTPS.

  4. Click Validate. Harvestr sends a test request to confirm your endpoint is reachable.

  5. (Optional) Add an HMAC signature for an extra layer of security. Harvestr signs each request so your endpoint can verify it came from us.

  6. Select the events you want to subscribe to.

  7. Click Save.

Your webhook will start receiving HTTP POST requests for every event you subscribed to.

Need an endpoint for testing? Tools like ngrok can create disposable URLs that forward to your local environment.

Delete a webhook

On the webhooks settings page, click the bin icon next to the webhook you want to remove.

Payload schemas and verification

For payload schemas, HMAC verification details, retry behavior, and the full webhook reference, see developers.harvestr.io/webhooks.

Did this answer your question?