Submit feedback
POST/api/v1/feedback/
Create a feedback entry for a project. This is the endpoint the feedback widget calls when a visitor submits the form; you can call it directly to submit feedback from your own UI.
No API key is required by default, but the url field must belong to
one of the domains configured for the project. Requests from other
origins are rejected with 403 Forbidden.
Projects can enable the require a submit key option. Submissions to
such a project must carry an API key with the feedback:submit scope
covering the project: requests without a key get 401 Unauthorized,
and requests with a key that lacks the scope get 403 Forbidden.
This suits internal sites and backend integrations where everyone who
can see the page may know the key, but outsiders cannot submit. The
project configuration's require_submit_key field tells you whether
a project has this enabled.
If the project has reCAPTCHA enabled, a valid recaptchaToken is
required.
A 201 response means the feedback was stored. A 202 response means
the feedback was stored, but the project's team has exceeded the free
plan limit; upgrade to keep collecting feedback reliably.
Request
Responses
- 201
- 202
- 400
- 401
- 403
- 404
- 429
Feedback stored.
Feedback stored, but the team is over the free plan limit.
Missing or invalid field, invalid screenshot payload, or failed reCAPTCHA verification.
The project requires a submit key and no API key was provided.
The url does not match any of the project's configured domains, or the provided API key lacks the feedback:submit scope.
No project exists with this identifier.
Rate limit exceeded.