Configure Connection
HappyFox guide
Create API credentials, configure the HappyFox connection in NIM, and collect data to validate access.
Before you beginDirect link to Before you begin
Review the vendor's API for HappyFox documentation and API key and auth code creation instructions.
NIM requires Hostname, Username, and Password. HappyFox API authentication uses an API key and auth code as the HTTP Basic authentication credentials.
Generate an API key and auth codeDirect link to Generate an API key and auth code
- Sign in to HappyFox and open Apps > Goodies > API. Enable API access if needed.
- Select +, name the key for NIM, and select Add new API key.
- Hover over the new key's row and select see auth code.
- Copy the API key and corresponding auth code to secure storage. Confirm the key is enabled.
If API settings are unavailable, contact HappyFox Support to enable access.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a HappyFox system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | Your HappyFox account hostname, using the format expected by the Connection screen. Use the hostname for your region or configured custom domain. |
| Username | The HappyFox API key, used as the HTTP Basic authentication username. |
| Password | The corresponding auth code, used as the HTTP Basic authentication password. |
The vendor's Tickets API reference includes the API key and auth code authentication format.
Validate with a collectionDirect link to Validate with a collection
Test Connection always returns success for this connector. Run a system collection to validate connectivity, authentication, and access to the required data.
- Save the connection settings and run a collection for the HappyFox system.
- Check collection status and review the contacts, knowledge base articles, and ticket information needed for your process.
- If collection fails, verify the Hostname, API key, auth code, enabled API access, permissions, and network access.
- Validate contact creation and updates with test records before enabling provisioning.
Validate each required collection separately. Successful data retrieval does not confirm permissions to create or update contacts.