For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mobile SDKs

Embed Pylon's chat widget in your iOS, Android, or React Native application.

Overview

Pylon's mobile SDKs allow you to embed the chat widget directly in your mobile app, providing users with in-app support without leaving your application.

Supported Platforms

  • iOS - Native Swift SDK for iPhone and iPad apps

  • Android - Native Kotlin SDK for Android devices

  • React Native - Cross-platform SDK for React Native applications

Setup

To integrate a mobile SDK:

  1. Get your App ID from the Chat Widget settings (EU)

  2. Follow the installation instructions for your platform in the GitHub repository

  3. Initialize the SDK with your App ID

  4. Set user information when a user logs in

  5. Add the chat view to your app's UI

For detailed installation instructions and API documentation, visit the GitHub repository for your platform:

EU Data Hosting

If your organization uses EU data hosting, point the SDK at the EU widget by setting both of these in the SDK config:

  • widgetBaseUrl: https://widget.eu.usepylon.com

  • widgetScriptUrl: https://widget.eu.usepylon.com/widget/APP_ID

What the SDKs Support

The SDKs load the same chat widget as the web, so your widget's styling and functionality settings apply. Method names vary slightly by platform; see your platform's README for exact signatures.

User details: email and name (both required), avatar URL, account ID or account external ID, and an HMAC email hash for identity verification. You can update or clear the user after login.

Methods:

  • Open and close the chat window

  • Show and hide the chat bubble

  • Open a new message, optionally prefilled with text or HTML

  • Set custom fields on new issues

  • Prefill ticket form fields

  • Open a ticket form or knowledge base article

Events:

  • Widget loaded, initialized, and ready

  • Chat opened and closed

  • Unread message count changed

  • Message received

  • Error

Not Supported in the SDKs

These web widget features aren't available in the mobile SDKs:

  • JWT identity verification. Use the HMAC email hash instead.

  • contact_id / contact_external_id

  • Setting the widget language (locale or setLocale)

  • setTheme (dark mode)

  • Push notifications

  • showIssue, getCurrentIssue, and onActiveIssueChange

  • setVisibleTicketForms

  • Survey and popup visibility events

  • Per-message customFields on showNewMessage

Last updated

Was this helpful?