Screenshot feedback
Capture a screenshot, draw, mosaic, crop and send a note.
Open feedback
Customers can choose Feedback beside the chat launcher to capture a screenshot and open the feedback composer. While chat is open, Report an issue is available in the chat menu. You can also connect your own button:
// Call directly from a user-activated button.
reportButton.addEventListener('click', () => {
BTX.feedback.open().catch(console.error)
})BTX renders the visible page to an image locally using JavaScript, without asking for screen-sharing permission. The screenshot stays local until the customer sends the report. If capture fails, the customer can attach an image or send a note. Cross-origin frames and assets without CORS access may be missing from the rendered image.
// Optional: start with your own images or videos.
await BTX.feedback.open({ attachments: [screenshotBlob, videoFile] })For a host-specific capture integration, set feedback.capture during configuration to an async function returning an image Blob. The default captures the current page without a permission prompt. The picker accepts supported images and videos. Count, type and size limits come from the project session; the current limit is four attachments, with at most one video. The editor scales the image to a maximum edge of 1600 pixels.
Review and edit
Capture more screenshots or attach images and videos. Each attachment has a removable thumbnail. Select an image to edit it separately. Choose Draw to mark it or Mosaic to pixelate a dragged rectangle. Crop shows a frame: drag an edge or corner to resize, or drag inside to move it, then choose Apply crop. Undo reverses the last edit; Save returns to the report. Cancel discards that editing session. The note has a fixed height. Configured guest name/email requirements also apply to feedback; identified customers use their signed profile.
Edits remain local until Send. The SDK flattens the edited image to PNG and uploads that result, then creates a feedback thread using the shared messaging API. The original screenshot is not uploaded alongside it. A note, attachments, or both may be sent.
Delivery and recovery
A failed send preserves the note and all attachments for another attempt. Unchanged retries reuse the report ID to avoid duplicate threads. Changing the draft creates a new report ID. After API acceptance, the SDK shows Thank you for your feedback. Feedback creates a separate thread and preserves the active support thread. A team reply shows an unread badge and preview; selecting the preview opens that thread. Customers can use the chat header’s Your threads button to return to earlier feedback and support threads. Switching identity or resetting disposes the report before another customer can use it.
document.addEventListener('btx:interaction', ({ detail }) => {
analytics.track('btx_control', detail) // surface + stable control name only
})
document.addEventListener('btx:unread', ({ detail }) => {
updateSupportBadge(detail.count)
})For custom launchers, configure messenger: { showLauncher: false } and call the messenger/feedback APIs from your own buttons. btx:unread reports the unread thread count for your Support badge.
The SDK emits btx:interaction with stable surface and control values for host analytics. It does not include notes, filenames, emails or customer IDs. btx:feedback-sent means the API accepted the report; it does not establish that an operator has read it.