Docs

Submit

Submit feedback via the API

Last updated:

This endpoint is what the Feedback SDK calls under the hood. You can call it directly if you’re not using the SDK.

Submit Feedback

POST /v1/feedback/submit Secret key
Submit a feedback entry for a given feedback type.
ParameterTypeRequiredDescription
feedbackTypeId (body)stringThe feedback type slug (created in the dashboard)
propertyId (body)stringProperty the feedback type belongs to
sessionId (body)stringSession the feedback belongs to (max 500 chars). Visitor and user identity are resolved from the session on the backend.
option (body)stringSelected option value (must match a pre-defined option)
message (body)stringFree-text message (max 5000 characters, only if feedback type allows text)
metadata (body)objectKey-value string pairs for additional context
Response
{ "success": true }
Example
bash
curl -X POST "https://api.sessionsight.com/v1/feedback/submit" \
  -H "x-api-key: YOUR_SECRET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "feedbackTypeId": "",
  "propertyId": "",
  "sessionId": "",
  "option": "",
  "message": "",
  "metadata": ""
}'

Notes

  • The feedbackTypeId must match a feedback type slug that exists in your dashboard for the given property
  • If option is provided, it must match one of the pre-defined option values for the feedback type
  • message is only accepted if the feedback type has text input enabled
  • metadata values must be strings