Skip to main content

Freshchat source

Introduction​

The Freshchat source connector lets you connect to your Freshchat account and (currently) validate credentials.

This connector is under active development. Extraction and stream support are not yet available.

Setup​

Prerequisites​

  • A Freshchat account
  • An API key with access to the Freshchat APIs

Account identifier​

You’ll need your Freshchat account identifier (the subdomain used in your Freshchat URL), for example:

  • If your Freshchat URL is https://acme.freshchat.com, your account identifier is acme.

The connector requires this value to be a valid DNS label:

  • Lowercase letters (a-z), digits (0-9), and hyphens (-) only
  • 1–63 characters
  • Cannot start or end with a hyphen

Authentication​

Freshchat uses Bearer token authentication.

Provide:

  • API key: used as the Bearer token in API requests

During credential validation, the connector makes a request to:

  • GET https://{account}.freshchat.com/v2/users?limit=1

Configuration​

FieldTypeRequiredDescription
accountstringYesFreshchat account identifier (subdomain), e.g. acme for https://acme.freshchat.com. Must be a valid DNS label (lowercase letters, digits, hyphens; 1–63 chars; cannot start/end with -).
api_keystringYesFreshchat API key used as a Bearer token.

Streams​

No streams are currently available. The connector’s extraction functionality is still in development.