Documentation

Documentation

YourOwn SetupYourOwn SDKYourOwn API
Sphere SetupSphere SDKSphere API
  • Resources

›Getting started

Getting started

  • Copilot.cx Mobile SDK
  • Importing the iOS SDK
  • Importing the Android SDK
  • SDK configuration

Getting started for flutter

  • Importing the Copilot.cx Android SDK for Flutter
  • Importing the Copilot.cx iOS SDK for Flutter
  • Interacting with the Copilot.cx SDK in Dart

Getting around

  • Hello Copilot

Reference

  • Application
  • Authentication
  • User
  • Thing
  • In-app messages
  • Report

Event reporting guide

  • Predefined events
  • Custom events

Appendix

  • Releases
  • Open source mapping

SDK configuration

Copilot.cx environment URL

The Copilot.cx environment endpoint URL allows the mobile application to send out calls to Copilot.cx servers.

Copilot.cx provides and environment URL for each deployment, so if you are using 2 environments - one for development and debugging purposes and one for production and distribution to end-users, Copilot.cx SDK can be configured to work with the development/production environment per your needs.

Application ID

Copilot.cx product ID provided by your Customer Success Manager. For example, "ICONNECT”.

Google services file - Firebase

Application should be configured to work with Firebase as its EventLogProvider. In order to wire-up Firebase and Copilot.cx the application should be setup on Firebase site following the setup guides for Android and iOS.

💡 Important: When releasing the application to the stores, do not forget so switch to production environment both Copilot.cx environment URL and the Firebase file.

GDPR compliance

In case your application should comply with GDPR (European data and privacy regulations, see GDPR official publication): Copilot.cx SDK can be configured to a GDPR compliant application mode or to a mode that does not require explicit user consent in order to collect and process data.

← Importing the Android SDKImporting the Copilot.cx Android SDK for Flutter →
Copilot
Mail: hello@copilot.cx
Call: (212).398.0001
© Copilot.cx 2025