Freshchat - Stackone

Getting Started

Create or Select a Project

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

Configure the Connector

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

API Key · Connector Profile

Uses a Freshchat API key, which reads the whole account. No app registration is needed.

Optionally, configure receiving Events for Freshchat into StackOne.

Webhooks setup

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:

API Key · Link Account

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

43 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.

Create Agent

Add an agent to the Freshchat account.

Update Agent

Update a Freshchat agent’s profile, role or groups.

List Agent Statuses

List the custom agent statuses configured in Freshchat.

Update Agent Status

Set a Freshchat agent’s current status to a custom status.

Delete Agent

Permanently delete a Freshchat agent.

List Channels

List the channels (topics) in the Freshchat account.

Create Conversation

Start a Freshchat conversation for a user in a channel, with its first messages.

Get Conversation

Get a Freshchat conversation by id.

Update Conversation

Change a Freshchat conversation’s status, assignment or properties.

List Conversation Properties

List the conversation properties configured in Freshchat (Freshsales Suite chat only).

Create CSAT Rating

Record a customer satisfaction (CSAT) rating for a Freshchat conversation.

Upload File

Upload a file to Freshchat to attach to a message.

Upload Image

Upload an image to Freshchat to use in a message.

List Groups

List groups in the Freshchat account.

Check Group Business Hours

Check whether a Freshchat group is currently within its business hours.

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 Messages

List the messages in a Freshchat conversation.

Send Message

Send a message to a Freshchat conversation as a user, agent or bot.

Send WhatsApp Outbound Message

Send an approved WhatsApp template message from the business number to one or more recipients.

List Outbound Messages

Get the delivery status of the messages in one WhatsApp outbound request.

Extract Raw Report

Request a raw CSV report of Freshchat events for a time range.

Get Raw Report

Get the status and download links of a raw report.

Get Historical Metrics

Get historical Freshchat CSAT, conversation and team performance metrics for a time range.

Get Instant Metrics

Get real-time Freshchat team presence counts.

List Roles

List roles in the Freshchat account.

List Users

Search Freshchat users (customers) by name, email, phone, reference id or time range.

Fetch Users By IDs

Get several Freshchat users at once by their user ids.

Get User

Get a single Freshchat user by id.

Create User

Create a Freshchat user (customer) record.

Update User

Update a Freshchat user’s email, name or phone.

Delete User

Permanently delete a Freshchat user and their data.

List User Conversations

List the conversations of a Freshchat user.

Events

4 events

Event