Developer Overview

Developer documentation is split into two parts:

Product guides in the Docs tab explain how to install, configure, and operate Woes.
The API Reference contains REST resources, authentication, scopes, examples, and interactive endpoint testing.

Developer Surfaces

Surface	Use it for
Public REST API	Server-side integrations for conversations, issues, clients, agents, sources, usage, and analytics.
Woes Terminal	In-app command console for fast navigation, inbox triage, issues, clients, context sources, notifications, and JSON snapshots.
Widget loader	Browser install for live chat and customer messaging.
Widget JavaScript API	Opening, hiding, theming, identifying, and pre-filling the widget.
Route map	Understanding public, widget, and authenticated workspace route families.
Workspace API keys	Private server-side credentials for the public REST API.

Where To Go

API Reference for REST endpoint docs.
Woes Terminal for the in-app command console, navigation, inbox commands, issue commands, context commands, and JSON output.
Authentication for bearer token usage.
API Keys for scopes and key handling.
Widget JavaScript API for browser commands.
Route Map for route-family boundaries.

Boundaries

Do not mix widget public keys with REST API keys. Widget keys identify a public widget install. REST API keys authenticate private server-side API calls.

Last modified on July 4, 2026