App Connect Connector Server API
HTTP API exposed by an App Connect connector server (called the CRM or adapter server in older code). The configured manifest serverUrl is the HTTPS base URL, without a trailing slash, to which App Connect appends these paths. The contract combines shared @app-connect/core routes with connector-specific routes implemented by this server; fields and supported capabilities can vary by connector where an operation delegates to a connector interface.
Authorization: userJwt is an App Connect CRM-session JWT issued by /apiKeyLogin or /oauth-callback; it is not a RingCentral OAuth token. X-RC-Access-Token carries a RingCentral OAuth credential for RingCentral user or administrator validation. Legacy jwtToken and rcAccessToken query parameters remain active for older clients, but credentials in URLs can leak through logs and browser history and should be avoided.
Legacy response convention: some connector operations return HTTP 200 with successful: false and returnMessage when the request was processed but the CRM operation failed. Callers must inspect the response body rather than treating every 2xx response as business success. Payloads can contain CRM records, communications content, recording URLs, and access tokens; do not log credentials or retain personal data beyond the workflow that requires it.
This public reference omits internal and application-specific endpoints.
About
| Field | Value |
|---|---|
| Version | 1.7.40 |
| OpenAPI | 3.0.3 |
Servers
| URL | Description |
|---|---|
https://unified-crm-extension.labs.ringcentral.com |
RingCentral Labs hosted server |
http://localhost:6066 |
Local development server |
https://{host} |
Self-managed connector server |
Resources
| Resource | Description | Operations |
|---|---|---|
| Health | Process liveness and legacy version metadata. Liveness does not imply database, connector, or upstream readiness. | 2 |
| Manifest | Connector manifests, capability discovery, release notes, and version metadata used by App Connect clients. | 3 |
| Auth | CRM authorization, managed-auth discovery, and App Connect user-session lifecycle. | 8 |
| Admin | RingCentral account settings, managed credentials, server-side logging configuration, and CRM user mapping. | 11 |
| User | Effective per-user settings and connector-owned CRM user information. | 5 |
| Contacts | Connector-backed CRM contact lookup and creation, including synthetic create-new choices. | 3 |
| Appointments | Connector-backed appointment listing, creation, partial update, refresh, confirmation, cancellation, and status changes. | 7 |
| Call Logs | CRM call-activity lookup and mutation, temporary note caching, and connector-defined dispositions. | 5 |
| Message Logs | CRM logging for RingCentral SMS, MMS, fax, voicemail, and grouped conversations. | 1 |
| Call Down | Server-owned scheduled call-back entries scoped to the current App Connect user. | 4 |
| Plugins | Account-level plugin installation, advisory licensing, legacy built-ins, and asynchronous completion callbacks. | 4 |
| RingCentral Reports | RingCentral account and extension reports generated with stored account OAuth credentials. | 4 |
Authentication
userJwt
HTTP bearer.
legacyUserJwt
Send the API key in the jwtToken query value.
ringCentralAccessToken
Send the API key in the X-RC-Access-Token header value.
legacyRingCentralAccessToken
Send the API key in the rcAccessToken query value.
Data models
Reusable schemas are documented in the model reference.