Skip to main content
Freshchat
Previewv0.1.0
14 actions · 1 auth method
IAM

​
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 · API Key

Uses the account’s Freshchat API key, which an account admin generates. The key reads the whole account, so no per-user…
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 · API Key

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

14 actions
Action
Description
Get Account Configuration
Get the Freshchat account’s configuration.
List Agents
List agents in the Freshchat account.
Get Agent
Get a single Freshchat agent by ID.
List Groups
List groups in the Freshchat account.
Get Unified Credentials
Get the current Freshchat connection’s unified credentials and identity.
List Unified Groups
List unified groups in a Freshchat account.
Get Unified Group
Get a unified Freshchat group by ID.
List Unified Organizations
List unified organizations in a Freshchat account.
Get Unified Organization
Get a unified Freshchat organization by ID.
List Unified Roles
List unified roles in a Freshchat account.
Get Unified Role
Get a unified Freshchat role by ID.
List Unified Users
List unified users in a Freshchat account.
Get Unified User
Get a unified Freshchat user by ID.
List Roles
List roles in the Freshchat account.