Skip to main content
OpenCX skills help your coding assistant install, configure, or upgrade the widget. They work with assistants such as Claude Code, Codex, and Cursor. The current examples pin Widget 5.4.2; keep the widget package version separate from the installed skill version. Run the command for your task in your app’s directory, then select your assistant when prompted. You need Node.js and npm installed.

Add or configure the widget

Then ask your assistant:
Use opencx-widget-integration to add OpenCX Widget 5.4.2 to this app with Companion mode. Exclude query strings, fragments, and private path or title data from page context.
Get your widget token from Channels → Web chat in your OpenCX dashboard.

Upgrade from v4 to v5

Then ask your assistant:
Use opencx-widget-migration to upgrade our widget from v4 to 5.4.2. Check our custom components, authentication, and self-hosted assets. Exclude query strings, fragments, and private path or title data from page context.
See the migration guide for the full upgrade checklist.

Add unread state or feedback to a custom UI

After installing the integration skill, ask:
Use opencx-widget-integration with Widget 5.4.2 to add an unread-session badge and report the first visible view, even when nothing is unread. Use the completed reply’s feedback signal for our helpfulness prompt. Preserve our authentication and storage.
See unread read tracking, macro reply options, and streamed feedback for the corresponding public APIs and version requirements.

Before applying changes

Skills give your assistant instructions. Installing one does not change your website, upgrade the widget, or enable features in your workspace. Ask for an exact published version and have the assistant check the current migration contract, including opt-in delivery and page permissions. Review the installed instructions and the code changes your assistant proposes. If a skill suggests sending a full page URL, use the safe page-context examples instead. To get a newer skill, rerun its installation command and review the changes. Keep the skill files and lockfile in version control with your app. Prefer to set up the widget yourself? See Install Widget and Companion mode.