LogoLogo
Click Here For More Support
  • 📍Get Started
    • Welcome
    • Who We Are
    • Our Product
  • 🤖AI Agent Engine
    • AI Agent Engine Basics
      • Get to Know Your AI Agent Engine
      • Glossary
      • Dashboard Overview
    • Manage Your Content
      • Response Types
        • Prewritten Plus Responses
          • Add New Prewritten Responses
          • Edit Prewritten Responses
          • Enrich Prewritten Responses
          • Response Refiner
        • Generated Responses
          • Web-Scraped Data
            • Troubleshooting
          • Documented Data
          • Enrich Generated Responses
        • Fallback Responses
      • Enrichments
        • Buttons
        • Quick Replies
        • Videos
        • Images & GIFs
          • Best Practices
      • Input Director
        • Copy & Paste Input Training
      • Best Practices
        • Locate Responses/Data
        • Revise Responses
        • Unpublish Responses
        • Content Formatting
        • Suppress Thumbs Up/Down
        • Content Groups
      • Upgrade to Context LLM
    • Install Your Chat
      • Web Installation
        • Advanced Pop-Up Options
      • InApp Webview Installation
        • App Provider Product Overview
        • iOS Advanced Install Guide
        • Android Advanced Install Guide
        • Passing Customer Identifiers
    • Enhance the Chat Experience
      • Pages
        • Add/View Chat Pages
        • Maintain State
        • Avatars
        • Chat Header Image
        • Input Container
        • Chat Background
      • Popups
        • Editor Field Definitions
        • Add/Edit Popups
        • Auto-Open
        • Prompt Bubble
        • Popup Button Image
        • Best Practices
      • Page Themes
        • Field Definitions
        • Adjust Page Themes
      • Activation & Drivers
        • Embed Webpages
        • Link Other Chats
        • Welcome Messages
      • Placement
        • Digital Placement
          • Chat Tile
          • Chat in Chat
        • In-Person Placement
      • Sponsor Inclusion
    • Features & Integrations
      • Channels
        • Facebook Messenger
          • Maintenance & Best Practices
        • Inbound SMS
      • Integrations
        • Ticket Commerce
          • Installation/Maintenance
          • Best Practices
        • Simpleview Integration
          • Listings
          • Events
          • Search Logic Summary
        • Zapier
          • Installation Guide
            • Connect to Salesforce
            • Connect to Google Sheets
        • FEVO
          • Installation Guide
          • Best Practices
        • Carbonhouse Integration
      • Features
        • Multi-Language Functionality
        • Mobile Ticketing Guide
        • Food & Beverage Finder
          • Installation/Maintenance
          • Best Practices
        • Weather Feature
        • Consent Form Feature
        • Satisfaction Score
        • 'Notify Subscription' Feature
    • User Management
      • User Types
      • Adjust User Type & Access
      • Add/Remove a User
      • Update Your Password
      • Unlock Your Account
      • Multi-Factor Authentication
    • Reporting & Analytics
      • Analytics Dashboard
        • Overview
        • AI Chat Performance Dashboard
        • Intent Explorer Dashboard
        • Intent Trends Dashboard
        • Intent Deep-Dive Dashboard
        • Bridge Agent Performance Dashboard
        • Mobile Ticketing Guide Dashboard
      • Data Reports
        • Conversation Transcripts
        • AI Resolutions Log
        • URL Link-Outs
        • Bridge Escalations
        • CSAT Entries
        • Ticket Commerce Records
        • End User Contacts
        • NLP Traffic Log
        • Input and Response Log
        • List URL Subscriptions
        • Get Response Feedback
        • Knowtifi Subscriptions
      • API Report Options
      • External IDs
      • UTM Tracking
      • Security Alerts
  • 📬Marketing Engine
    • Marketing Engine Basics
      • Get to Know Your Marketing Engine
      • Glossary
      • Login to Your Account
    • Marketing Calendar
      • How to Use the Marketing Calendar
    • Segments
      • Segments Overview
      • Uploading Contacts Manually
      • Uploading Contacts in Bulk
      • Importing a File into Unsubscribe List
      • Manage Contact Lists
      • Create Custom Object & Custom Fields for Contact Data Management
      • Contact Engagement Rules
      • Folders
      • Audience
        • Audience Dashboard
        • Audience Filters/Segments
        • Create a Meta Audience
        • Create a Audience Using Marketing Engine
      • Best Practices
        • Use Send Time Optimization
    • Templates & Landing Pages
      • Email Templates
        • Create & Preview an Email Template with Dynamic Content
      • SMS/MMS Template
      • WhatsApp Template
        • WhatsApp Carousel Template
        • WhatsApp LTO Template
        • WhatsApp Product Message Templates
      • Webpush Template
      • Mobilepush Template
      • Landing Page Template with a Form
      • Social Conversation Templates
    • Campaigns
      • Messaging Campaigns
        • Select Your SMS/MMS Sender Number
        • How to Create an SMS/MMS Campaign
        • Enable Double Opt-In
        • Messaging Campaign Report
        • Best Practices
        • SMS Regulations
          • SMS Regulations for India
          • SMS Regulations for Canada
          • SMS/MMS Regulations for USA
      • Social Campaigns
      • Email Campaigns
        • Create an Email Campaign
        • Update an Email Campaign
        • Email Campaign Report
        • Smart AI Tools
        • Best Practices
          • Reduce SPAM rate in emails
          • Craft Compelling Email Pre-Header Text
    • Journeys
      • Overview
      • Journey Blocks
      • Journey Templates
      • Create a Journey
      • Variant Testing
      • Conversion Tracking
      • Campaign or Journey Metadata
      • Advanced Filters for Sorting Campaigns/ Journeys
      • WhatsApp Journey
        • How to Use WhatsApp for Commerce
        • How to Send a WhatsApp One-Way Notification
        • Send a WhatsApp Audio Message
        • Automated WhatsApp Welcome Journey
        • WhatsApp Journey Report
      • Best Practices
        • Email Journey Strategy for Ticket Buyers
        • Journey Examples
    • Settings & Integrations
      • Integrations
        • Ticketing Integrations
          • Ticketmaster Integration
            • Best Practices
          • SeatGeek Integration
          • Glitnir Ticketing Integration
        • E-Commerce Integrations
          • Shopify
        • Website Tracking
          • Track Your Website
          • JavaScript Tracking Client
          • Track WordPress Websites
          • Track Shopify Stores
          • Enable User ID Tracking
        • Zapier Integration
      • User Management
        • Account Types
        • Add/Remove a User
        • Adjust Role & Access
        • Update Your Password
        • Two-Factor Authentication
      • Settings
        • Add Email Sender Addresses to Launch Campaigns
        • Connect Your Email Domain with the Marketing Engine
        • Connect Your Social Accounts
        • Connect your Shopify Store
        • Integrate Webpush Notifications
        • Setup Segment-based Engagement Rules
    • Factcubes
      • Fan Maturity Model
  • đź’¬Live Agent Engine
    • Get to Know Your Live Agent Engine
    • System Configuration
      • Installation Guide
      • Escalation Schedule
      • Multiple Team Involvement
      • Leave a Message & Contact Collection
      • Conversation Labels
      • Additional Channels & Placement
        • Bridge Placement
        • Bridge Email
          • Installation Guide
        • Facebook Messenger
    • Agent Overview
      • Logging In
      • Dashboard Overview
      • Profile Setup
      • Notification Preferences
      • Set Your Availability
      • Conversation Status
      • Assign a Conversation
      • Reply in a Conversation
      • Canned Responses
        • Add/Use a Canned Response
        • Modify/Delete a Canned Response
        • Best Practices
      • Participate in a Conversation
      • Private Notes & Mentions
      • Mute/Block a User
      • Prioritize Conversations
      • Resolve a Conversation
      • Export Transcripts
      • Macros/Automation
      • Keyboard Shortcuts
      • Ending Your Shift
      • Troubleshooting
    • Admin Overview
      • Adjust Team Assignments
      • Update Agent Status
      • Additional System Controls
    • Data & Reporting (Bridge)
    • Bridge Mobile App
  • SYSTEM UPDATES & SUPPORT
    • Help Center
    • Release Notes
      • Archived Product Updates
Powered by GitBook
On this page
  • Overview of Satisfi Labs
  • App Installations
  • InApp Webview
  • Native App
  • How to configure user profile variables
  • URL variables (preferred for InApp Webview)
  • Header variables
  • Personalization
  • Personal Identifiable Information (PII)
  • Data Resource Overview
  • API endpoints for data resources
  • Support

Was this helpful?

Last updated 7 months ago

Was this helpful?

The following document is intended for mobile app providers to further understand Satisfi Labs and communicate its high-level product offering as well as mobile app installation process. This document will outline the following:

  • Overview of Satisfi Labs

  • App installation instructions

  • Personalization

  • Personal Identifiable Information (PII)

  • Data Resource Overview

  • Support

Overview of Satisfi Labs

Satisfi Labs provides conversational AI and Live Chat products that assist brands (“clients”) in maintaining accurate, continuous, and on-brand communication with their customers. These offerings provide a two-way chat solution throughout all stages of a user’s journey.

Satisfi Labs provides in-depth intent, input, and volume reporting resources as part of its core product offering. All standard data resources are available for our app provider partners to ingest via API endpoint for use in additional data analysis and subsequently share with their clients that use Satisfi Labs. You can jump to an overview of these standard resources in this document by .

A deeper overview of Satisfi’s product is .

App Installations

Satisfi Labs supports two different “look and feel” options when installing an experience on mobile apps:

  1. Chat link loaded into a mobile app webview, referred to as “InApp Webview” (most popular)

  2. Native app chat integration with custom UI

Installation instructions vary slightly depending on the desired chat look and feel. Please review the following sections based on the intended design and installation option.

InApp Webview

The easiest way to install a Satisfi Labs chat experience is to load a chat page URL inside the mobile app’s webview. This installation method will load the Satisfi chat in the webview (with Satisfi’s page theme customized for the client).

Installation Overview

Once a Satisfi Labs chat experience has been built, the client will receive a chat page link from a Satisfi Labs onboarding specialist for install. This chat page will be specified as an InApp Webview chat page for reporting purposes.

NOTE: To ensure that your reporting data remains accurate, only add InApp-specific page links within the app. This can be verified with your Satisfi Labs onboarding specialist.

Sample Page Link: https://chat.satis.fi/?pageID=XXXX

This link can be loaded within a webview behind a chat bubble, tile, or other navigation piece.

Advanced Installation Guides

For additional instruction, as well as methods of troubleshooting, please see the advanced installation guides for both iOS and Android mobile applications, linked below.

Native App

Some client users may prefer to develop their own custom UI for a Satisfi Labs chat experience within their mobile app. In these cases, app providers will need to coordinate with client users to design the UI and integrate with Satisfi Labs’ Chat API.

How to configure user profile variables

Satisfi Labs has two configuration methods, URL variables and header variables, that enable an app provider to pass user identifying variables to ingest and tie out to a user’s message data. By default, Satisfi supports four different variables to be stored to its user profiles:

  • ClientEndUserId (i.e., okta, GUID, etc.) → defined as extid=[value]

  • Email → defined as em=[value]

  • Mobile Number → defined as mnum=[value]

  • Custom Field → defined as cf=[value]

An app provider can send one variable or a combination of up to all four variables in order to be associated with the user’s submission data for reporting.

The following sections provide more detail on how to configure an app installation of the chat experience such that user profile variables are included.

URL variables (preferred for InApp Webview)

The easiest method of providing an ClientEndUserId, email address, or phone number, or custom field to Satisfi Labs is to append the variables in the chat page link URL. When installing the Satisfi page link, append to the URL using the format &[variable]=[value], passing the user’s value in the URL. This will create a submission for the user with the variable and value saved.

Sample page link: https://chat.satisfi4.com/?pageID=[XXXX]&cf=[value]&em=[value]&mnum=[value]&extid=[value]

Header variables

An alternate configuration option for user variables requires passing header variables rather than appending variables to the chat URL. In these cases, it is best to work with Satisfi Labs’ development team to define the variables being passed and coordinate testing efforts.

Personalization

At this time, no data (such as full name, email address, or purchase information) passed from an app provider to Satisfi Labs is used to personalize conversation content or bot messages.

Personal Identifiable Information (PII)

In our standard experience, a user is considered anonymous. Satisfi Labs generates a customer code and submission code to track conversation data; however, no PII is collected unless specific features are installed.

A number of feature add-ons (i.e., Bridge live escalation, Knowtifi) are available and can collect PII such as the user's full name, email address, and phone number. Typically these features, once installed, include corresponding data resources for reporting that may be accessed via an API endpoint.

Data Resource Overview

The following data resources are standard for Satisfi Labs chat experiences.

Conversation Transcripts

Reviews all messages to and from bots/agents

Context LLM Processing Log

Reviews bot outcomes/performance

Bridge Escalations

Reviews data per live escalation

Ticket Commerce Orders

Reviews search and purchase outcomes

Customer Feedback

Reviews customer satisfaction via CSAT submissions

Customer PII Records

Collects customer PII (e.g Bridge, Knowtifi, etc)

URL Link-Outs

Reviews how often bots are driving users to site pages, and which pages

All data resources include a ClientEndUserId value when the install is configured to receive an app provider’s user identifier. Further, all data resources can be accessed via an API endpoint for easy import into data visualization software. Clients have access to these standard data resources within the Satisfi Dashboard and can retrieve the API endpoints to share with their App Provider for analysis at any time.

Note: In cases where clients have custom features installed, additional data resources may be available.

API endpoints for data resources

Each data resource has a corresponding API endpoint that can be used to generate a URL for export. Data resources can be exported as a file or viewed within a browser. The supported formats available are: Excel (file export only), CSV, JSON, Tab Delimited, or HTML. The generated URL can then be saved and called as needed.

Support

If you need to request that an InApp page be created, please submit a through the Satisfi Labs request portal.

Select examples of chat promotion in app

for Satisfi Labs’ Chat API documentation. If you need further assistance, please submit a through the Satisfi Labs request portal.

Note: While the variable will always be defined as cf=, the custom field variable can be further defined within the Satisfi Labs dashboard for reporting purposes. To adjust the label of “custom field” in conversation data, please submit a through the Satisfi Labs request portal.

To request that a chat experience be configured to use header variables for user profile information, please through the Satisfi Labs request portal.

For more information on any features installed in a client’s app chat experience and the PII collected within these features, please through the Satisfi Labs request portal.

If at any point you need support in retrieving an API endpoint for data resources, please submit a in the Satisfi Labs request portal.

If at any point you need installation support or have a question, please submit a in the Satisfi Labs request portal.

Partner Request support ticket
Advanced Installation guide for (iOS)
Advanced Installation guide (Android)
Click here
Partner Request support ticket
Partner Request support ticket
submit a Partner Request
submit a Partner Request
Partner Request ticket
Partner Request ticket
covered here
clicking here
Page cover image