Developer Docs | Kommunicate

Developer Docs | Kommunicate

  • Book a Demo
  • Try For Free

›Flutter Mobile

Web

  • Installation
  • CMS Installation
  • Authentication
  • Conversation
  • Conversation Assignment
  • Customization
  • Localization
  • Logout
  • Troubleshooting

Android

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Localization
  • Logout
  • Migration
  • Troubleshooting

iOS

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Configuration
  • Localization
  • Logout
  • Troubleshooting

React Native

  • Installation
  • Expo Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Logout
  • Troubleshooting

Flutter Mobile

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Localization
  • Troubleshooting

Flutter Web

  • Installation
  • Authentication
  • Conversation

Ionic/Cordova

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Localization
  • Logout
  • Resolving Errors

Ionic/Capacitor

  • Installation
  • Authentication
  • Push notification
  • Customization

Rich Messages

  • How To Use
  • Types of Rich Messages

Bots

  • Bot setup
  • Dialogflow Integration
  • Lex Integration
  • Kompose Bot Builder
  • IBM Watson Integration
  • Custom Bot Integration
  • Import Kompose Bot
  • Bot Samples

Integrations

  • Zapier
  • WhatsApp
  • WhatsApp 360Dialog
  • WhatsApp Twilio
  • WhatsApp Cloud API
  • Instagram Integration
  • Telegram Integration
  • Sunshine Integration
  • Freshdesk Integration
  • Pipedrive Integration
  • Agile Integration

Platform APIs

  • Authentication
  • Endpoints

Dashboard Features

  • Analytics
  • Conversations
  • Users
  • Bot Integration
  • Helpcenter
  • Campaign Messaging
  • Settings

Configuration

  • Single Sign On (SSO) Setup
  • Webhooks
  • Access Token URL
  • Email Fallback

Authentication

To authenticate a user, create a user object and then pass it to the login function. The User object has the following properties:

parametersdescription
userIdUnique ID for the user
displayNameDisplay name of the user. Agents will identify users by this display name
emailEmail ID of logged in user
passwordUser's password
imageLinkThe image of the end-user, which will be visible to the agents in the kommunicate dashboard
authenticationTypeIdPass 1 for authentication from kommunicate
APP_IDPass your APP_ID here
deviceApnsType0 for development, 1 for release

There are 2 ways to Login:

1. Visitors

Login the user anonymously as below:

 KommunicateFlutterPlugin.loginAsVisitor(APP_ID).then((result) {
      print("Login as visitor successful : " + result.toString());
    }).catchError((error) {
      print("Login as visitor failed : " + error.toString());
    });

2. Existing Users

If you have the user details, then pass the user details to create a user object:

    dynamic user = {
      'userId': <USER_ID>,  //unique userId
      'password': <PASWWORD>,   //password is optional
      'appId': APP_ID
    };

Then pass the user object in the login function as below:

KommunicateFlutterPlugin.login(user).then((result) {
      print("Login successful : " + result.toString());
    }).catchError((error) {
      print("Login failed : " + error.toString());
    });

If the user is logged in or not, one can check by calling the 'isLoggedIn' function:

 KommunicateFlutterPlugin.isLoggedIn().then((value) {
        if (value) {
          print("User is already logged in");
        } else {
          print("User is not logged in");
        }
      });

Update user details

Use the below function to update the details of the logged in user.

    dynamic kmUser = {
       'displayName': 'New display name',
       'contactNumber': 'New contact number',
       'imageLink': 'New pofile image url',
       'email': 'New email Id',
       'metadata': {   //Pass any Key-Value pair(String, String) here. This will be displayed under User Info section in the dashboard
               'key1': 'value1',
               'key2': 'value2'
           }
     };
      
    KommunicateFlutterPlugin.updateUserDetail(kmUser)
        .then((response) {
      print("User details updated successfully : " + response.toString());
    }).catchError((error) {
      print("Error occurred while update user details : " + error.toString());
    });

Note: All the fields in the kmUser object above are optional. updateUserDetail function has to be called after conversationBuilder's success

Here is the sample app which implements this SDK: https://github.com/Kommunicate-io/Kommunicate-Flutter-Plugin/tree/master/example

Logout

You can call the logout method to logout the user from Kommunicate. Use the method as below:

  KommunicateFlutterPlugin.logout();
← InstallationPush Notification →
  • There are 2 ways to Login:
    • 1. Visitors
    • 2. Existing Users
  • Update user details
  • Logout

Ready to automate more than 80% of your customer support?

Try for Free
  • support@kommunicate.io
  • United States
    (+1) (310) 402-2374
  • India
    (+91) 974-057-0196
  • Learn
    • iOS Chatbot
    • Amazon Lex Chatbot
    • Chatbot in Android
    • ChatGPT with Flutter
    • Document to Chatbot
    • React Native Chatbot
    • Create Flutter Chatbot
    • Whatsapp Business API
    • Integrate React Js Chatbot
    • Whatsapp Chatbot Using NodeJs
    • Integrate ChatGPT With Whatsapp
    • Integrate Dialogflow With Whatsapp
    • ChatGPT For Product Engagement
    • Product
    • AI Chatbot Builder
    • Generative AI Chatbot
    • Customer Experience
    • Chatbot Features
    • Dialogflow Integration
    • FAQ Chatbot
    • Live Chat
      Industries
    • Healthcare Chatbot
    • E-commerce Chatbot
    • Education Chatbot
    • Banking Chatbot
  • Integrations
    • E-commerce Chatbot Integration
    • Omnichannel Chatbot
    • Chatbot Integration
    • Chatbot for Website
    • Mobile Apps Chatbot
    • Chatbot for CRM's
    • Automation and Analytics
    • Zendesk Chatbot Integration
  • Resources
    • Chatbots Templates
    • Case Studies
    • Whitepapers
    • Chatbot Guide
    • Videos
    • Knowledge Hub
    • Comparisons
    • ROI Calculator
    • Blogs
    • Company
    • Partner Program
    • Affiliate Program
    • Pricing
    • About Us
    • Media
      Support
    • Contact Us
    • HelpCenter
    • Stack Overflow
    • API Status
  • Comapare
    • Kommunicate Vs Verloop
    • Kommunicate Vs Intercom
    • Kommunicate Vs Yellow
    • Kommunicate Vs Twak
    • Kommunicate Vs Ada
Arabic
Hindi
Spanish
French
German
Portuguese
Urdu
Software Advice Frontrunners for Live Chat Mar-22Software Advice Frontrunners for Live Chat Mar-22crozdesk badgeISO certificationHIPAA complianceGDPR compliant - GDPR Copy 12Created with Sketch.COMPLIANT
Copyright © 2025 Kommunicate.io.
T&C Privacy Policy Career SLA DPA Sitemap