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.
Create an access token
The API authenticates with access tokens. Create one for each app or script that calls the API, so you can revoke them one by one. Only Editors and Owners can see and manage access tokens.
Go to Settings > Integrations > Public API and click Create token.
In Name, enter the app or purpose. Everyone in the organization can see it, so never put a secret there.
Under Access, pick only what the app needs:
Feedback: Read, Create, Update
Users and companies: Read, Write
User attributes: Read, Write
Discoveries: Read, Write
Roadmaps: Read, Write
Click Create token, copy the token from Copy your token now, then click Done. Harvestr shows it only once.
A token's access can't be changed later: create a new token instead. To revoke a token, open its ⋯ menu and click Revoke token.
Send the token in the X-Harvestr-Private-App-Token header of every request. Rate limits are 10 requests per second and 50,000 per day.
How feedback is matched to a customer
When you create feedback, Harvestr looks for an existing customer with the requester's externalUid first (case sensitive), then their email, then their name. It stops at the first match. A matched customer only gets the identifiers it was missing: existing values are never overwritten.
The feedback content accepts HTML or Markdown. For a line break, use <br> or a Markdown line break: a plain \n in HTML content is ignored.
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 |
| New feedback arrives in your inbox. |
| Feedback in your inbox is updated. |
| A new discovery is created. |
| A discovery is updated. |
| A new component is created. |
| A component is updated. |
| Feedback is linked to a discovery. |
| Feedback linked to a discovery is updated. |
In the webhook form, these appear as Created and Updated on the Messages, Discoveries, Components and Feedback rows.
Set up a webhook
Go to Settings > Integrations > Webhooks and click Add webhook.
(Optional) Enter a Secret. Harvestr then signs the URL check and every request with it, in the
X-Harvestr-Signatureheader, so your endpoint can verify it came from us.Enter your Endpoint URL and click Check URL. Harvestr sends a POST with a challenge: your endpoint must answer with a 2xx status within 5 seconds, without redirecting. Wait for Verified.
Under Events, tick the events you want to subscribe to.
Click Add webhook. The button stays disabled until the URL is verified and at least one event is ticked.
Your webhook will start receiving HTTP POST requests for every event you subscribed to. Webhooks can't be edited yet: to change one, delete it and add it again.
Need an endpoint for testing? Tools like ngrok can create disposable URLs that forward to your local environment.
Delete a webhook
On Settings > Integrations > Webhooks, open the webhook's ⋯ menu and click Delete webhook.
Payload schemas and verification
For payload schemas, HMAC verification details, retry behavior, and the full webhook reference, see developers.harvestr.io/webhooks.
