Skip to documentation

Create and organize inboxes

Route widget and API events to a named inbox and keep collection keys distinct from resource IDs.

Updated Read as Markdown

An inbox is a destination for feedback events from a widget or the collect API. Put separate experiences in separate inboxes when you need different review queues—for example, documentation helpfulness and checkout feedback.

Create an inbox

  1. Select the organization and brand.
  2. Open Inboxes → Create Inbox.
  3. Enter a name, an inbox key and an optional description.
  4. Save, then open the inbox to view its installation example and feedback.

The inbox key is the public routing identifier used in an embed or POST /collect. It is not an API credential. The inbox ID identifies the resource in management API URLs. The API key authenticates a request and must be authorized for the same organization and, if scoped, the same brand.

json
{
  "inboxKey": "docs-helpfulness",
  "type": "thumbs",
  "score": 1,
  "comment": "The example answered my question."
}

Choose the feedback type in the widget or submission. The collection types are thumbs, stars, csat, nps, emoji and text. Keep a consistent scale within an experience so that reviewing its scores is useful.

Verify routing before launch

Submit a recognizable test comment from the actual page where the widget is installed. Check the inbox, event type, score, page URL and context. If an inbox key changes or is regenerated, update every embed and integration using the old key.

A form's full response set is reviewed in Feedback Pages. Do not assume an inbox event and a multi-question form response have identical fields or analytics; use the forms workflow for complete questionnaires.

Common problems

  • Create Inbox is unavailable: select a brand and check your creation permission and account resource allowance.
  • Invalid inbox key: compare the saved key with the exact value sent by the client.
  • Key cannot access this inbox or brand: use an organization collection key belonging to the correct organization and brand.
  • Daily limit reached: check the account usage view. Widget and collect-API feedback uses a daily meter that resets at midnight UTC.

See Inbox API reference for programmatic management and Feedback follow-up for reviewing events after they arrive.