Skip to content
App Connect for RingEX
EmptyObject
Initializing search
Home
Integrations
Solutions
Documentation
Developer guide
MCP
Support
Admin Console
Developer Console
App Connect for RingEX
Home
Integrations
Integrations
Overview
AgencyZoom
Bullhorn
monday.com
Clio
ConnectWise
Freshdesk
GoHighLevel
Google Sheets
Insightly
NetSuite
Odoo
Pipedrive
Redtail CRM
ServiceNow
Smokeball
Zoho
Solutions
Solutions
Overview
Embedded communications
Sales velocity
Supervision & monitoring
Automated logging
AI-generated insights
Universal connector
Documentation
Documentation
Overview
Installation
App Connect 2.0 Beta
App Connect 2.0 Beta
What's new
Download
New CRMs
New CRMs
AgencyZoom
monday.com
Odoo
ServiceTitan
Smokeball
Zoho
Developers
Developers
Connector migration guide
Proxy connector (new)
Plugins (new)
App Connect features
App Connect features
AI Assistant
Appointments (2.0)
Call-back lists (2.0)
Call monitoring (2.0)
Click-to-dial
Metrics and reports
Presence and status
RingCX support (experimental)
Screen-pop
Sending & receiving SMS
Voicemail drop (2.0)
Call Logging
Call Logging
Logging overview
Resolving logging conflicts
Logging calls automatically
Call log prompts
Administration
Administration
Becoming an admin
Managed settings
Plugins (new)
Server-side call logging
AI Conversation Expert (ACE) logging
User settings
User settings
Overview
Audio input/output
Phone number formats
Preferred device
Region
Language and localization
Appearance
Advanced options
Advanced options
Developer options
Browser options
Developer guide
Developer guide
Introduction
Developer Console
Is your CRM compatible?
Plugins
Plugins
Getting started
API reference
API reference
Overview
Health
Health
Check plugin-server liveness
Registration
Registration
Register a RingCentral account
Token lifecycle
Token lifecycle
Validate or rotate the plugin credential
Invocation
Invocation
Process a logging payload synchronously
Start asynchronous plugin processing
Licensing
Licensing
Get plugin license status
OAuth
OAuth
Create a plugin authorization URL
Check plugin authorization state
Disconnect the plugin user
Complete plugin OAuth authorization
Models
Models
Overview
HealthResponse
TextError
PluginRegistrationRequest
PluginRegistrationResponse
EmptyObject
EmptyObject
Table of contents
Type
Example
LoggingPayload
PluginConfig
PluginInvocationRequest
AsyncCallbackInvocationRequest
AsyncFireAndForgetInvocationRequest
AsyncAcceptanceResponse
AsyncRejectedResponse
AsyncPluginCallbackRequest
AsyncPluginCallbackResponse
PluginLicenseStatus
PluginAuthUrlResponse
PluginAuthStateResponse
PluginLogoutRequest
ReturnMessage
Connectors
Connectors
Getting started
Authorization
Manifest
Manifest
Manifest properties
Customizing pages
Custom settings
Regional services
Sample manifest
Server
Server
Build and deployment
Contact lookup
Contact lookup
Contact matching
Placeholder contacts
Lead creation
Logging phone calls
Associating calls with CRM records
Logging SMS
Server-side logging
Viewing contacts and activities
Returning errors
Interfaces
Interfaces
Overview
Authentication
Authentication
getAuthType
getBasicAuth
getOauthInfo
getUserInfo
refreshUserInfo
unAuthorize
Call logging
Call logging
findContact (by phone)
findContactWithName
createContact
createCallLog
updateCallLog
getCallLog
getLogFormatType
upsertCallDisposition
SMS logging
SMS logging
createMessageLog
updateMessageLog
Server-side logging
Server-side logging
getLicenseStatus
getUserList
Appointments
Appointments
listAppointments
createAppointment
updateAppointment
refreshAppointment
cancelAppointment
confirmAppointment
Lifecycle hooks
Lifecycle hooks
authValidation
checkAndRefreshAccessToken
getOverridingOAuthOption
getServerLoggingSettings
updateServerLoggingSettings
postSaveUserInfo
API reference
API reference
Overview
Health
Health
Check HTTP process liveness
Return server version metadata
Manifest
Manifest
List implemented connector methods for a platform
Return a platform manifest
Get release notes for connector versions
Auth
Auth
CRM OAuth callback
API-key login
Disconnect a CRM user
Get connector license status
Validate the current CRM authentication
Get admin-managed API-key auth state
Get admin-managed OAuth state
Resolve hostname metadata for a platform
Admin
Admin
Read admin settings
Save admin settings
Read admin-managed API-key credentials
Save admin-managed API-key credentials
Cache admin-managed OAuth credentials
Delete cached admin-managed OAuth credentials
Delete account-scoped admin-managed OAuth credentials
Resolve CRM user mappings
Reinitialize admin user mapping
Read server-side logging settings
Update server-side logging settings
User
User
Return a hash for the current user info
Preload user settings for a platform
Refresh connector-owned CRM user information
Read user settings
Update user settings
Contacts
Contacts
Find contacts by phone number
Create a contact
Find contacts by name
Appointments
Appointments
List appointments
Create an appointment
Update an appointment
Update an appointment status
Refresh an appointment
Confirm an appointment
Cancel an appointment
Call Logs
Call Logs
Fetch existing call logs
Create a call log
Update a call log
Cache a call note before full logging
Upsert call dispositions
Message Logs
Message Logs
Create or update an SMS/fax/message log
Call Down
Call Down
List scheduled call-back entries
Schedule a call-back entry
Update a call-back entry
Delete a call-back entry
Plugins
Plugins
Register a plugin for an account
Remove a local plugin registration
Get plugin license status for a user
Receive an async plugin callback
RingCentral Reports
RingCentral Reports
Generate an admin report
Generate an admin user report
RingCentral admin OAuth callback
Generate a debug report URL
Models
Models
Overview
ReturnMessage
ApiKeyLoginRequest
ApiKeyLoginResponse
ErrorResponse
GenericSuccessResponse
BasicMutationResponse
ContactInfo
ContactSearchResponse
CreateContactRequest
ContactMutationResponse
RcParty
RcCallRecording
RcCallLogLeg
RcCallLogRecord
AdditionalSubmission
CreateCallLogRequest
UpdateCallLogRequest
CallLogInfo
CallLogLookupItem
CallLogLookupResponse
CallLogMutationResponse
CallLogUpdateResponse
CallNoteCacheRequest
CallDispositionRequest
MessageAttachment
MessageParty
RcMessage
MessageCorrespondent
MessageConversationLog
MessageLogRequest
MessageLogResponse
AsyncPluginCallbackRequest
AsyncPluginCallbackResponse
AppointmentStatusUpdateRequest
ServerVersionInfoResponse
ImplementedInterfacesResponse
UserInfoHashResponse
DebugReportUrlResponse
PluginRegisterRequest
PluginMutationResponse
AuthValidationResponse
ManagedAuthStateResponse
ManagedOAuthStateResponse
UserSetting
UserSettings
UserSettingsEnvelope
UserSettingsUpdateRequest
AdminSuccessMessage
AdminSettingsUpdateRequest
ManagedAuthFieldDefinition
StoredFieldValue
ManagedAuthAdminUserValue
ManagedAuthAdminResponse
ManagedAuthUpdateRequest
ManagedOAuthValues
AdminManagedOAuthCacheRequest
AppointmentAttendee
AppointmentContactReference
AppointmentCreateRequest
AppointmentPatchRequest
AppointmentListResponse
HealthResponse
ReleaseNoteItem
ReleaseNoteSections
ReleaseNotesResponse
AppointmentCreateInput
AppointmentPatchInput
AppointmentFailureResponse
AppointmentCreateResponse
AppointmentRecordResponse
AppointmentActionResponse
IdentifiedAppointment
CallDownEntry
CallDownCreateRequest
CallDownPatchRequest
CallDownCreateResponse
CallDownListResponse
CallDownMutationResponse
MCP
Support
Support
Getting help
Knowledge base
Knowledge base
No "Connect" button visible
Contact not found during call lookup
Calls stuck in "Pending" or "preparing data..."
Submitting bug reports
Build a CRM connector
Build a CRM connector
Overview
Captivo Labs
Gate6
Loyally
RingCentral
RingClone
Data sharing
Release notes
Table of contents
Type
Example
Home
Developer guide
Plugins
Models
EmptyObject
Empty JSON object used as the token synchronization request body.
Type
object
Example
{}