Skip to navigation

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

userIdstringOptional

Your user id (or the SDK’s browser id for a visitor).

hashstringOptional

hex HMAC-SHA256 of userId under your user-signing secret, from your server.

anonymousIdstringOptional

The SDK’s browser id, when there is no user id.

pathstringOptional

The page’s path.

previewstringOptional

A preview or teach token (rydhm_pv_…), from a Preview or Teach link: shows a coach that is in testing.

Response

OK
expertmap from strings to any

id, name, kind, avatarUrl (only from Rydhm’s own hosts), face, firstMessage.

bubblemap from strings to any
enabled, position, accent, theme, label, launcherText, greeting, modes.
userobject
announcementslist of maps from strings to any
guideslist of maps from strings to any
pageMaplist of maps from strings to any
clientToolslist of strings
learnPagesboolean

The SDK reports what it sees on each page (POST /engine/page-inventory) for the app map: an Onboarding coach with learnAppMap on.

audienceenum

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).

Allowed values:
previewobject or null

The preview or teach token the browser presented (?preview=), when it is valid for this expert.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error