See our Welcome page for a quick overview on how to get going.
We have an endpoint that accepts POST requests with JSON payloads. The X-API-Key header is used for authentication. Your API key is visible in the Settings tab of the Two Thumbs Slack app, and can also be rotated there.
An example request looks like this:
curl -X POST 'https://ingest.twothumbs.io/feedback' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: $secret' \
-d '{
"prompt": "Happy with our documentation?",
"thumb_up": true,
"comment": "Short and sweet!",
"origin": "Two Thumbs",
"category": "Documentation",
"in_production": true,
"user_id": $uid
}'
We enforce the following limits:
If you ever get close to these limits, look into implementing sampling; you already receive more than enough feedback.
The following three fields are used to categorize feedback:
origin should be used to name the source of received feedback, as appropriate to your application,category should be used to further group received feedback, as appropriate to the value of origin, andprompt should be used to define the experience feedback is given about; if the prompt is presented to the user (most cases), it should be presented verbatim and it should give the user enough context to give informed feedback.The unique combination of these three fields is called a prompt in our Slack app, and in billing contexts (the Lite plan includes 1 prompt and the Advanced includes 20). Prompts are automatically recorded to the Prompts tab of our Slack app, where they can be deleted together with the associated feedback data.
Feedback is automatically deduplicated based on the user_id field, which should be a unique identifier for the user giving feedback. Only the latest feedback from a user for a given prompt is shown in the displayed time range; all comments remain visible, and raw data exports include duplicate data.
Feedback older than six months is automatically deleted on the first weekday each month. This ensures focus stays on relevant data, and keeps privacy simple.
The Two Thumbs Slack app is the only UI for Two Thumbs and is also used for settings and support. Your subscription is linked to your Slack workspace using the activation code sent in the welcome email.
See our Privacy Policy and Terms of Service.
For any questions, feel free to contact us via electronic mail at "hello" at this domain.
Your feedback helps shape our documentation. Please do not include any sensitive information.