App Connect Plugin Server API
Provider-side HTTP contract for independently hosted App Connect plugin servers. Most paths mirror the JavaScript plugin template; /oauth/callback is an illustrative plugin-owned target selected through OAuth state.redirectTo. Complete URLs in the plugin manifest, not these sample paths or servers, are authoritative.
App Connect calls registration, token, invocation, and license endpoints server-to-server. Its browser extension calls OAuth endpoints directly, so those endpoints need restricted CORS and a plugin-owned correlation or session mechanism. Production endpoints must use HTTPS. Requests can contain RingCentral access tokens, plugin bearer credentials, user configuration, contact and communications data, and recording URLs containing access tokens. Do not log credentials, and retain personal data only as required.
The current protocol has no uninstall callback. Removing a plugin deletes the App Connect registration only, so plugin providers need their own stale-account cleanup, credential revocation, and data-retention policy.
About
| Field | Value |
|---|---|
| Version | 1.7.41 |
| OpenAPI | 3.0.3 |
Servers
| URL | Description |
|---|---|
https://{pluginHost} |
Developer-hosted plugin server |
http://localhost:6066 |
Local plugin development server |
Resources
| Resource | Description | Operations |
|---|---|---|
| Health | Optional process-liveness convention from the JavaScript template; it is not part of App Connect invocation readiness. | 1 |
| Registration | Server-to-server RingCentral account validation and plugin-issued credential bootstrap. | 1 |
| Token lifecycle | Server-to-server validation and rotation of the stored account-scoped plugin credential. | 1 |
| Invocation | Synchronous payload transformation, asynchronous background work, and App Connect completion callbacks. | 2 |
| Licensing | Optional advisory account-entitlement status displayed by the App Connect browser client. | 1 |
| OAuth | Optional browser-facing authorization URL, state, logout, and plugin-owned provider callback endpoints. | 4 |
Authentication
pluginBearer
HTTP bearer.
Data models
Reusable schemas are documented in the model reference.