Create a mobile chatflow using the mobile chat SDK (BETA)

You can create a mobile chatflow in HubSpot and use the mobile chat SDK to integrate HubSpot's chat functionality into an iOS or Android app. With the mobile chat SDK, you can provide a contextual support experience and leverage other HubSpot self-service features such as integrating a bot or knowledge base into your chat experience.

Create a mobile chatflow

To create a mobile chatflow in HubSpot that will integrate with the mobile SDK:

• In your HubSpot account, navigate to Automations > Chatflows.
• In the top right, click Create chatflow.
• Click Mobile.

• Click the top dropdown menu to select a specific help desk or inbox to associate the chatflow with.
• Click the language dropdown menu and select a language.
• Enter a mobile tag:
  • A mobile tag is required for HubSpot to determine which chatflow you want to display in your app. Your developers should include this tag in the associated configuration file of your app to allow your chatflow to be properly identified.
  • Multiple chatflows can share the same mobile tag. If this occurs, the chatflow with the highest priority level will appear in your app. Learn more about adjusting the priority of your chatflows in this article.

• Click Next.
• On the Chatflow page, in the left sidebar, select a live chat option:
  • If you want a visitor to be able to immediately start a chat with you and your team via your app, select Live chat.
  • If you're a user in a Service Hub Professional or Enterprise account and have at least three published knowledge base articles, you can select Knowledge base search & live chat to add the option to search the knowledge base directly from your app.
• Click Create.

Implement the SDK

To find the configuration file you'll need to start developing and implementing the mobile chat SDK:

• In your HubSpot account, click the settings settings icon in the top navigation bar.
• In the left sidebar menu, navigate to Inbox & Help Desk > Inboxes.
• Hover over the channel you want to display in your app and click Edit.
• On the Channels tab, click Mobile SDK in the left sidebar menu.
• Click the iOS Settings or Android Settings tab based on the platform you're developing for.
• Under Configuration file, click Copy to copy the contents of the configuration file to your clipboard, or click Download Code to download the configuration file directly.

Use this configuration file as you develop your iOS or Android app. Learn more about how to get started using the developer documentation links below:

• iOS:
  • SDK
  • Documentation
• Android:
  • SDK
  • Documentation
  • Binary file hosting

Please note: you can use a hybrid framework with the mobile chat SDK (e.g., React Native, Flutter, Ionic, etc.), but you'll need to develop your own hooks to the associated iOS and Android APIs to implement the SDK.

Confirm successful implementation in HubSpot

Once you finish implementing the SDK in your app, release an app update so that your customers can start using the new chat widget within your app. You can then confirm that the widget is successfully installed in your HubSpot inbox settings:

• In your HubSpot account, click the settings settings icon in the top navigation bar.
• In the left sidebar menu, navigate to Inbox & Help Desk > Inboxes.
• Review the list of connected channels on the Channels tab. The status for Mobile in the Chat row should appear as green.

Mobile properties in reporting tools

Once your customers start using your embedded chat widget, you can report on detailed chat insights and analytics using HubSpot's reporting tools.

The following mobile-specific properties are available:

• Platform: the specific platform of the device (i.e., iOS, Android, web).
• Device model: the specific model of the device (e.g., iPhone 12, Samsun Galaxy S21, etc.).
• OS version: the version of the operating system of the user's device (e.g., iOS 17, Android 14, etc.).
• Device orientation: whether the user was viewing the app horizontally or vertically during the chat.
• Screen resolution: the screen resolution of the user's mobile device during the chat.
• Battery level: battery level of the user's mobile device during the chat.
• Notification permission: whether the user has enabled notifications on their mobile device.
• Camera permission: whether the user has enabled photo library permission on their mobile device.
• Location permission: whether the user has enabled location permission on their mobile device.
• Location: optionally allow the app to specify geographic coordinates for the user.