imiconnect Developer Hub

Welcome to the imiconnect developer hub. You'll find all the resources to help you get started with imiconnect quickly. We are here to support you if you get stuck. Let's jump right in!

Get Started    API Reference

Overview of SDKs

The imiconnect SDKs provide a framework on which to build rich in-app messaging and push notification experiences within mobile and web based applications.

Our Core SDK provides the capabilities required to register for and receive in-app messages and push notifications, monitor device attributes such as location, and trigger custom events.

Our UI SDK provides a suite of user interface components which can be used to build a message inbox and rich, bi-directional, chat experiences.

Core SDK

This table summarises the main features provided by the Core SDK, please explore our reference documentation for a complete view of all supported features.

Feature
Description

Device registration

Allows a device to be registered with the imiconnect platform, this is mandatory before other features may be used.

Attribute monitoring

Allows a range of device attributes to be monitored and sent to the imiconnect platform for use within customer journey orchestration.

Push notifications

Allows push notifications to be received and displayed. Push may contain simple text, imagery and interactions.

In-App messaging

Allows in-app messages to be sent and received. Unlike push, the Core SDK only supports the transport of in-app messages, display must be handled through custom code or by leveraging the imiconnect UI SDKs.

Topic subscriptions

Allows users to be subscribed or unsubscribed from topic based messaging.

Custom events

Allows custom events to be sent to the imiconnect platform for use within customer journey orchestration.

Technology / Platform support

Technology
Platform
Description

Native

Android, iOS

Native platform support for Android and iOS, for use with applications written with Kotlin, Java, Swift or Objective C.

Cordova

Android, iOS

Our Cordova plugin wraps the native SDKs to allow usage within Cordova applications.

Javascript

Web

Used for applications that run within a web browser. Please note that this cannot be used within frameworks that run in WebViews, such as Cordova.

UI SDK

This table summarises the main areas for which the UI SDK provides components, all components are extensible / customizable to varying degrees, please refer to the documentation reference for full details.

Feature
Description

Composing messages

A pluggable composer UI component is provided for composing messages, including support for emoji and attachments.

Conversation

Various high to low level components for displaying a list of incoming and outgoing messages, including message bubbles, avatars, typing indicators and read/unread status.

Conversations list

Various high to low level components for displaying a list of conversations.

Inbox

A component for displaying a simple list of messages.

Updated 4 months ago

Overview of SDKs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.