SDK/REFERENCE
Configuration
Options for new EdithPro(), <EdithProProvider> and EdithProPlugin. Only clientId and workspaceId are required.
OptionTypeDescription
clientIdstring · requiredYour public client ID from the dashboard.
workspaceIdstring · requiredThe workspace recordings are saved to.
theme'light' | 'dark'Popup colour scheme. Default light.
logoUrlstringLogo in the popup header.
dashboardUrlstringWhere the popup’s Home link goes. Default https://app.edithpro.app.
user{ id: string, … }The user to attribute recordings to. Extra fields are stored with the recording.
metadata.folderIdstringDefault folder for new recordings.
metadata.titlestringDefault title. Falls back to the page title.
metadata.*anyAny other fields are saved as custom metadata.
apiUrlstringAPI base URL. Default https://sdk-api.edithpro.app.
wsUrlstringLive upload URL. Default wss://sdk-api.edithpro.app.
Callbacks such as onStop go in the same object. See Callbacks.
example
new EdithPro({ clientId: 'ep_live_abc123', workspaceId: 'ws_64f2a1b3', theme: 'dark', logoUrl: 'https://your-app.example/logo.svg', user: { id: 'user_123', name: 'Jane Smith', plan: 'team' }, metadata: { folderId: 'folder_abc', title: 'Support request', ticketId: 'T-4821' },});
Was this page helpful? @edithpro/sdk 1.0.5 · Edit this page