FeedByte

Concepts

Organization, Location, Station, Survey, Response, Capture link, and App.

FeedByte vocabulary is small and strict. Use these words in payloads, URLs, and support tickets.

Hierarchy

Organization
  └── Location
        └── Station

Organization is the tenant. A restaurant, hotel, or bank is an organization — not a separate kind of account.

Location is a physical or logical site inside an organization: a branch, a channel, a site.

Station is a feedback point inside a location: a table area, a programme, a teller desk.

Capture objects

Survey is the questionnaire. It is instant (emoji sentiment, optional tags) or detailed (Likert, NPS, choice, text, with jump rules). Lifecycle: draftactivearchived.

Capture link is a time-bound public survey URL issued by an App. It carries partner metadata (a call id, ticket, agent) and resolves at /l/{linkId}. One link per call or other external record. See Capture links.

Response is one submitted survey. Quality flags mark speed traps and straight-lining. metadata is a JSON object written at submit: partner keys from the Capture link sit at the top level; browser telemetry is nested under client.

Menu and menu scan belong to FeedByte's menu capability. A scan is a recorded opening of a menu, not a survey response.

App

An App is a third-party integration you register. It authenticates with API keys or OAuth, calls the API, and receives webhooks.

Auth objects

ObjectRole
Secret key fb_live_… / fb_test_…Server-to-server, scoped to one Organization
Publishable key fb_pk_live_…Capture SDK in the browser
Webhook secret whsec_…HMAC verification of inbound events
OAuth access tokenAn App acting on a signed-in user's organization

See Authentication.

On this page