Connecting to HappyFox (extractor)

Important

Any references to third-party products or services do not constitute Celonis Product Documentation nor do they create any contractual obligations. This material is for informational purposes only and is subject to change without notice.

Celonis does not warrant the availability, accuracy, reliability, completeness, or usefulness of any information regarding the subject of third-party services or systems.

The Celonis HappyFox extractor integrates the Celonis Platform with your HappyFox Help Desk to retrieve ticketing, user, and knowledge base data via the REST API. It supports the following basic features:

Prerequisites

This section details important prerequisites or prerequisite knowledge for using this extractor.

HappyFox authentication methods

The HappyFox REST API uses basic authentication. To connect to your HappyFox instance, you need to provide a username and password.

Available HappyFox endpoints

The default HappyFox extractor allows you to call these endpoints:

Method	Endpoint	Description
GET	Canned actions	Retrieve data about canned actions.
GET	Contact groups	Retrieve data about contact groups.
GET	Knowledge articles	Retrieve data about knowledge articles.
GET	Knowledge sections	Retrieve data about knowledge sections.
GET	Staff	Retrieve data about staff.
GET	Ticket categories	Retrieve data about ticket categories.
GET	Ticket custom fields	Retrieve data about custom fields.
GET	Ticket priorities	Retrieve data about ticket priorities.
GET	Ticket statuses	Retrieve data about ticket statuses.
GET	Tickets	Retrieve data about tickets.
GET	User custom fields	Retrieve data about user custom fields.
GET	Users	Retrieve data about users.

Further HappyFox information

For further information about Happyfox APIs, see: Happyfox Support - Developers - APIs.

Configuring the HappyFox extractor

This section describes the basic setup of configuring the HappyFox extractor. To configure the extractor:

In the Celonis Platform left navigation, select Data > Data Integration.
On the Data Pools screen, select the data pool where you want to integrate the extractor. This opens the Data Integration window.
Note
If you have not yet configured a data pool for this data set, see Creating and managing data pools.
In the Input section, select the Connect to Data Source tile. This opens the Add Data Connection window.
Note
If this is not the data pool's first connection, the Data Connections window opens below. Select + Add Data Connection to add a new connection.
In the Add Data Connection window, select Connect to Data Source. This opens the in-tool connection catalog.
In the connection catalog, select the HappyFox extractor. This opens the configuration window.
In the configuration window, provide the requested data for each field.
(Optional) Toggle the Advanced settings option to open the advanced configuration options. Read through each option and update as needed.
Select the Test Connection button to confirm the extractor can connect to the host system. If the test fails, adjust the data in the configuration fields as needed.
Once the test connection passes, select the Save button to continue. This returns you to the Data Integration window.

You have now connected the HappyFox extractor to your host system. To create and execute data jobs, see Extracting and transforming data.