API

Every method below is a member of a module on the HailerApi instance you construct (see Getting started). Each returns a Promise unless noted, runs on the host with the current user's permissions, and throws a HailerError on failure.

How calls work

The runtime client is a thin wrapper. Calling hailer.<module>.<method>(...) sends a message to the host Hailer frame, which runs the matching operation and returns the result. Each module page lists the host operation each method maps to, plus any host-side validation, scoping, or behavior that isn't visible from the signature alone.

Scope affects results

Results depend on whether your app is private or workspace-scoped. This is called out per method where it matters — read Private vs workspace apps first.

Modules

Data & workspace

Module	Purpose
user	Current user, look up users, list workspace members.
workspace	Current/available workspaces, create workspaces, product installs.
workflow	List/get workflows, install workflow templates.
activity	CRUD + print activities; kanban and ball sub-modules.
team	Teams grouped by workspace.
permission	The current user's permission map.
file	Get/upload files, add/remove tags.
insight	List insights and read their data.
metrics	Read usage metrics.

Apps, marketplace & integrations

Module	Purpose
app	Marketplace lookups for the running app; app config updates.
product	CRUD on your own marketplace products.
http	Authenticated proxy: fetch, upload, openWebSocket.
public	Endpoints callable without a session (the only namespace in outside mode).
ui	Command the host frame: open panels, dialogs, snackbars.

Internal

Documented for completeness. These target Hailer-operated surfaces and are not intended for third-party apps.

Module	Purpose
payment	Pricing and purchases.
admin	Instance-admin endpoints.

Types

All payload and entity shapes are catalogued in the Types reference.