HqO

Integration Types

Beyond HqO's built-in integrations, you can connect the HqO app to third-party apps and services using lightweight integration types β€” webview, deep link, SAML partner link-out, and native device integrations.

Overview

Integration types let you add capabilities to the HqO platform that aren't provided by HqO software β€” linking tenants to amenity partners, parking apps, fitness portals, and other services they already use. These integrations and their data live in your HqO instance and are configured with support from your HqO Customer Success Manager.

TypeWhat it doesBest for
WebviewOpens a third-party website inside HqO's in-app browserServices with a mobile-friendly web experience
Deep linkOpens a third-party native app, or its app store listing if not installedPartners with a rich native app but no web or API integration
SAML partner link-outOpens a partner's web app with the user automatically signed inWeb-based partners that support SAML 2.0
NativeLaunches the device's messaging, phone, or email appContact actions β€” text, call, or email a service provider

Webview integrations

A webview brings the user directly to a website β€” for example, a partner's booking portal β€” inside HqO's built-in browser. The user views the third-party site without leaving the HqO app.

Requirements: the third-party service must offer a mobile-friendly (or responsive) web experience.

Configuring a webview

Webviews can be added in two places:

  • Utility button β€” contact your HqO Customer Success Manager to add the webview URL as a utility button.
  • Call-to-action (CTA) in content β€” add the URL as a CTA when creating content in HqO Admin.

⚠️ Note: HqO's data tracking stops once the user taps into the webview. Activity inside the third-party site is not tracked by HqO.

A deep link connects the HqO app to a third-party native app. If the user already has the app installed, the link opens it directly; if not, the user is taken to the relevant app store listing to download it.

Deep links are a good fit when a partner has a rich native app experience but doesn't support SAML or API integration.

Configuring a deep link

  1. Request the deep link URL from the third-party provider.
  2. Provide the URL to your HqO Customer Success Manager to add as a utility button.

Security Assertion Markup Language (SAML) is an open standard for exchanging authentication and authorization data between an identity provider and a service provider. SAML partner integrations open a partner's webview experience with the user automatically signed in β€” no separate login required.

In this model, HqO acts as the identity provider (IdP) and the third-party web provider acts as the service provider. HqO signs SAML responses using Base64-encoded certificates and provides the partner with a certificate and key to authorize requests.

πŸ’‘ Tip: This is the reverse of Single Sign-On (SSO) for signing in to HqO, where HqO is the service provider and your company's identity platform is the IdP.

Requirements

RequirementDetail
SAML supportThe partner must support SAML 2.0 (IdP-initiated)
Web experienceThe partner must offer a mobile-friendly or responsive webview
AuthenticationAuthentication must occur at the email level, if required by the partner

Setup

Contact your HqO Customer Success Manager to configure a SAML integration or explore potential SAML solutions. Setup typically takes 2–4 weeks, and setup and maintenance fees may apply. Once configured, admins manage SAML integrations as utility buttons.

Native integrations

Native integrations link from the HqO app to apps pre-installed on the user's device for text messaging, phone calls, or email.

FormatExampleBehavior
SMSsms:1234567890Opens the messaging app with the number pre-filled (or the existing conversation, if one exists)
Telephonetel:5551234567Prompts the user to call the number
Mail-tomailto:concierge@example.comOpens the default email app with the To: field populated

Configuring a native integration

  • Utility button β€” contact your HqO Customer Success Manager.
  • Call-to-action (CTA) in content β€” add the link as a CTA when creating content in HqO Admin.

Programmatic integrations

Deeper, API-based integrations are available through an Enterprise Development engagement, which begins with a feasibility assessment. Contact your HqO Account Manager for details.

Was this page helpful?

Ask HelpHub

Ask me anything about HqO

I can help you find information in the documentation.