Skip to main content

HappyFox

Introduction​

The HappyFox source connector connects to the HappyFox Help Desk API.

At this time, the connector supports credential validation (testing connectivity/authentication), but data extraction is still in development. As a result:

  • The connector does not currently produce any streams.
  • Running an extraction will fail with an “in development” error.

Setup​

Before configuring the connector, gather the following from your HappyFox account:

  • Account: Your HappyFox account subdomain (the part before happyfox.com / happyfox.net).
  • API key and Auth code: HappyFox API credentials used for HTTP Basic authentication.
  • Region: Whether your HappyFox domain is happyfox.com or happyfox.net.

Authentication​

This connector uses HTTP Basic Authentication against the HappyFox API:

  • Username: API key
  • Password: Auth code

Credential validation is performed by calling:

GET https://{account}.happyfox.{region}/api/1.1/json/categories/

Configuration​

FieldTypeRequiredDescription
accountstringYesYour HappyFox account subdomain. Must be a valid DNS label: lowercase letters (a-z), digits (0-9), and hyphens (-) only; 1–63 characters; cannot start or end with -.
regionstringYesHappyFox domain region. Must be either com or net.
api_keystringYesHappyFox API key used as the Basic Auth username.
auth_codestringYesHappyFox auth code used as the Basic Auth password.

Streams​

No streams are currently available because extraction is still in development.