Page load: the expert, the bubble, what is due for this user
What the SDK calls on every page load; no voice cost. Records the user (end_user.created the first time). Announcements are those due for this user now; guides, those whose trigger matches this page or that are in progress.
A publishable key (Authorization: Bearer rydhm_pk_…), from one of the key’s allowed websites: the Origin header must be on its list. Never a secret API key (401 secret_key_not_allowed). Rate limited per visitor and per key.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
Your user id (or the SDK’s browser id for a visitor).
hex HMAC-SHA256 of userId under your user-signing secret, from your server.
The SDK’s browser id, when there is no user id.
The page’s path.
A preview or teach token (rydhm_pv_…), from a Preview or Teach link: shows a coach that is in testing.
Response
id, name, kind, avatarUrl (only from Rydhm’s own hosts), face, firstMessage.
The SDK reports what it sees on each page (POST /engine/page-inventory) for the app map: an Onboarding coach with learnAppMap on.
Who sees the coach. testing without a valid preview token: bubble.enabled is false, no guides or announcements, and sessions are refused (403 coach_testing).
The preview or teach token the browser presented (?preview=), when it is valid for this expert.