​
Completed state

At the end of this guide, a trusted CRM Plugin is installed from a supported source, its declared capabilities and configuration have been reviewed, its worker is healthy, and one test sync has left Plugin-owned logs and state.

​
Prerequisites

You need access to Plugin Manager, the package or source, its configuration and external-service requirements, and a rollback or uninstall point. Plugins run installed worker and frontend code. Capability checks constrain host bridge operations, but they are not a sandbox for untrusted packages.

​
Install the CRM Plugin

  1. Open Plugin Manager and select the supported package or source for the CRM Plugin.
  2. Review its identity, version, worker and UI bundles, configuration fields, external services, tools, events, jobs, webhooks, and requested host capabilities.
  3. Confirm that every tool name is Plugin-namespaced and that the Plugin does not claim ownership of core Issue, Approval, budget, authentication, or checkout rules.
  4. Enter required configuration through Plugin settings. Keep credentials out of the package and logs.
  5. Install and activate the Plugin. Inspect worker health and startup logs before using its project panel.
  6. Trigger one account sync. Check the Plugin’s job record, logs, state, and any linked Rudder work.
  7. Before an update, compare version, capabilities, configuration changes, and migration notes. Stop depending work before uninstalling.

​
Success signal

Plugin Manager shows the expected version and healthy worker. The test sync is attributed to the Plugin, and its status, logs, and state are inspectable. Core Issues, Runs, approvals, and budgets still follow their original Rudder surfaces and rules.

​
Recovery

If activation fails, leave the Plugin disabled and inspect manifest validation, configuration, worker health, and logs. Fix the named package or capability problem before retrying. A forbidden bridge call should fail and remain logged, not be worked around through an internal route. If an update breaks the Plugin, stop its jobs and webhooks, return to the last reviewed package when your install source supports that recovery, or uninstall through Plugin Manager. Uninstall must stop Plugin workers and reconcile Plugin-owned state without deleting core Rudder records.