> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Freshchat

> How to set up the Freshchat connector, plus the actions and events that are available.

![Freshchat](https://stackone-logos.com/api/freshdesk/filled/svg)

Previewv1.0.0[See changelog](https://docs.stackone.com/connectors/freshchat/changelog.md)

[43 actions](#actions) · [4 events](#events) · 1 auth method

Customer Support
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/freshchat/guides/connector-profile/api-key.md)
>
> Uses a Freshchat API key, which reads the whole account. No app registration is needed.

Optionally, configure receiving Events for Freshchat into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/freshchat/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

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

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/freshchat/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

43 actions

ActionDescription

Get Account Configuration`freshchat_get_account_configuration`

Get the Freshchat account's configuration.

List Agents`freshchat_list_agents`

List agents in the Freshchat account.

Get Agent`freshchat_get_agent`

Get a single Freshchat agent by ID.

Create Agent`freshchat_create_agent`

Add an agent to the Freshchat account.

Update Agent`freshchat_update_agent`

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

List Agent Statuses`freshchat_list_agent_statuses`

List the custom agent statuses configured in Freshchat.

Update Agent Status`freshchat_update_agent_status`

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

Delete Agent`freshchat_delete_agent`

Permanently delete a Freshchat agent.

List Channels`freshchat_list_channels`

List the channels (topics) in the Freshchat account.

Create Conversation`freshchat_create_conversation`

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

Get Conversation`freshchat_get_conversation`

Get a Freshchat conversation by id.

Update Conversation`freshchat_update_conversation`

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

List Conversation Properties`freshchat_list_conversation_properties`

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

Create CSAT Rating`freshchat_create_csat_rating`

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

Upload File`freshchat_upload_file`

Upload a file to Freshchat to attach to a message.

Upload Image`freshchat_upload_image`

Upload an image to Freshchat to use in a message.

List Groups`freshchat_list_groups`

List groups in the Freshchat account.

Check Group Business Hours`freshchat_check_group_business_hours`

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

Get Unified Credentials`freshchat_unified_get_me`

Get the current Freshchat connection's unified credentials and identity.

List Unified Groups`freshchat_unified_list_groups`

List unified groups in a Freshchat account.

Get Unified Group`freshchat_unified_get_group`

Get a unified Freshchat group by ID.

List Unified Organizations`freshchat_unified_list_organizations`

List unified organizations in a Freshchat account.

Get Unified Organization`freshchat_unified_get_organization`

Get a unified Freshchat organization by ID.

List Unified Roles`freshchat_unified_list_roles`

List unified roles in a Freshchat account.

Get Unified Role`freshchat_unified_get_role`

Get a unified Freshchat role by ID.

List Unified Users`freshchat_unified_list_users`

List unified users in a Freshchat account.

Get Unified User`freshchat_unified_get_user`

Get a unified Freshchat user by ID.

List Messages`freshchat_list_messages`

List the messages in a Freshchat conversation.

Send Message`freshchat_send_message`

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

Send WhatsApp Outbound Message`freshchat_send_whatsapp_outbound_message`

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

List Outbound Messages`freshchat_list_outbound_messages`

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

Extract Raw Report`freshchat_extract_raw_report`

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

Get Raw Report`freshchat_get_raw_report`

Get the status and download links of a raw report.

Get Historical Metrics`freshchat_get_historical_metrics`

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

Get Instant Metrics`freshchat_get_instant_metrics`

Get real-time Freshchat team presence counts.

List Roles`freshchat_list_roles`

List roles in the Freshchat account.

List Users`freshchat_list_users`

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

Fetch Users By IDs`freshchat_fetch_users`

Get several Freshchat users at once by their user ids.

Get User`freshchat_get_user`

Get a single Freshchat user by id.

Create User`freshchat_create_user`

Create a Freshchat user (customer) record.

Update User`freshchat_update_user`

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

Delete User`freshchat_delete_user`

Permanently delete a Freshchat user and their data.

List User Conversations`freshchat_list_user_conversations`

List the conversations of a Freshchat user.

## Events

Tags

Select all
|
Clear

Conversations

Messages

Webhooks

No tags found

4 events

EventDescriptionTags

Message Created`freshchat_webhook_message_create`Manual setup

Fires when a message is posted in a conversation by a user, an agent or the system, including agent private notes. Fresh...

MessagesWebhooks

Conversation Assigned`freshchat_webhook_conversation_assignment`Manual setup

Fires when a conversation is assigned to an agent or a group. Freshchat event `conversation_assignment`.

ConversationsWebhooks

Conversation Resolved`freshchat_webhook_conversation_resolution`Manual setup

Fires when a conversation is resolved. Freshchat event `conversation_resolution`.

ConversationsWebhooks

Conversation Reopened`freshchat_webhook_conversation_reopen`Manual setup

Fires when a resolved conversation is reopened by a user or an agent. Freshchat event `conversation_reopen`.

ConversationsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.