hc1

How to set up the hc1 connector, plus the actions that are available.

Previewv0.1.0

See changelog

19 actions · 1 auth method

CRM

Getting Started

1. Create or Select a Project

   Set up a new project or select an existing one. See Organizations & Projects.

2. Configure the Connector

   Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

   

   Connector Profile · Username and Password

   Signs in as an hc1 user and acts with that user’s role. The user must not have multi-factor authentication turned on.

3. Link an Account

   Link an account from the dashboard (or via StackOne Hub).

   See the guide for the authentication type chosen in the Connector Profile:

   

   Link Account · Username and Password
4. Use Actions

   Connect an AI platform to the linked account’s actions. See AI Platforms.

   Other ways to call actions are listed in Protocols & SDKs.

Actions

19 actions

Action

Description

Get Session

hc1_get_session

Get the signed-in user, tenant, permissions and record type catalog.

Get My Account

hc1_get_my_account

Get the signed-in user’s account, roles and access.

List User Apps

hc1_list_user_apps

List the hc1 applications the signed-in user can open.

Get Realm

hc1_get_realm

Get the configuration of the connected hc1 realm (tenant).

List Dashboards

hc1_list_dashboards

List the hc1 analytics dashboards the signed-in user can see.

List Cases

hc1_list_cases

List cases (service issues) in hc1.

List Contacts

hc1_list_contacts

List contacts (providers and staff) in hc1.

List Memos

hc1_list_memos

List memos (notes) in hc1.

List Organizations

hc1_list_organizations

List organizations (clinics and accounts) in hc1.

Get Organization

hc1_get_organization

Get one organization by id with all of its fields.

Get Record

hc1_get_record

Get any hc1 record by id and record type.

Search Records

hc1_search_records

Search hc1 records of chosen types by text.

Get Record Type Metadata

hc1_get_record_type_metadata

Get the fields and saved list views of an hc1 record type.

List View Records

hc1_list_view_records

List the records in a saved hc1 list view.

List Tasks

hc1_list_tasks

List tasks in hc1.

Get Tenant Settings

hc1_get_tenant_settings

Get the hc1 tenant settings, subscription and disk usage.

List Active User Emails

hc1_list_active_user_emails

List the email addresses of all active hc1 users.

List Announcements

hc1_list_announcements

List current hc1 system announcements.

List Attachment Statuses

hc1_list_attachment_statuses

List the review statuses an hc1 attachment can have.