Before You Begin

Before you begin, you need Philips Hue developer credentials for OAuth authentication. Your MiSP or Integrator can provide these, or you can obtain them yourself with a Philips Hue Developer account.

IMPORTANT: Work with your MiSP or Integrator to set up OAuth authentication using these credentials. You cannot use your subscription until OAuth authentication has been set up successfully.

Log in to your Philips Hue Developer account at https://developers.meethue.com/my-apps/.
On the Remote Hue API app ids page, click Add new remote Hue API app.
Fill in the Add new Hue Remote API app page.
Give your app a unique App Name and fill in the Application description.
Use one of the following for the Callback URL value:
- Staging: https://stagingapi.ipaas.com/HookApi/v2/Authorization/AuthorizationComplete
- Production: https://api.ipaas.com/HookApi/v2/Authorization/AuthorizationComplete
Copy the Client ID and Client Secret from the Application Created Successfully dialog.

With these credentials configured, you can create and connect a subscription.

Installation Instructions for Integration Setup

Go to Subscriptions Management and click Search Certified Integration Marketplace and Subscribe.
Click the Philips Hue integration tile.
Click Subscribe.
Enter a name for the subscription and select a version. Use any relevant, unique name within your company.
- Format: [Product Name] - [Environment/Purpose]
- Example: Philips Hue - The Example Company
Select Create Default Mappings (recommended). This creates the starter light-command collections for you; if you leave it unchecked, you configure your mapping collections manually.
Enter the API Throttle Limit. This controls how many API requests can run in the throttle window, protecting system performance.
- Recommended Values: Initial Setup: 5 · Ongoing Operations: 500 · High Volume: 500
Enter the API Throttle Seconds — the time window the throttle limit is measured over.
- Default: 60 seconds
Enter the number of Concurrent Connections — the maximum simultaneous API connections the subscription processes.
- Default: 5 · Range: up to 10
Enter the number of Concurrent Batch Executions — the maximum simultaneous batch executions for the integration.
- Default: 5 · Range: up to 10
Click Apply to save the settings.

The Hue Bridge User, Access Token, and Refresh Token are not entered by hand — they are filled in automatically when you authenticate in the next section.

Authentication Configuration

Philips Hue uses OAuth. You start the connection from iPaaS.com and approve it in your Philips Hue account:

Open the Philips Hue subscription settings and click the Authenticate icon in the top toolbar.
Sign in with your Philips Hue account when prompted.
Review the permissions and click Grant permission.
Click Close Page when prompted.
Refresh your subscription. If the connection succeeded, the Access Token, Refresh Token, and Hue Bridge User are saved automatically.

Important: iPaaS.com renews the Access Token automatically using the Refresh Token, so you do not normally need to re-authenticate unless the connection is revoked in your Philips Hue account.

For an ongoing reference to each setting and how authentication works, see Philips Hue Connections and Settings.

Post-Installation Verification

After installing, send a test command to confirm the integration works end to end. The connection is exercised as part of this test.

Navigate to Data Management > Customer and click Add Customer. Fill in the fields per your mapping guidelines, then click Apply.
Select Edit on the newly created customer record.
Copy the customer record ID from the browser URL.
Navigate to Integration Monitoring > Manual Sync.
Configure the sync:
- System: Philips Hue
- Mapping Collection: New VIP Customer
- Scopes: customer/created or customer/updated
Enter the customer record ID in the iPaaS.com ID field.
Click the Debug button. The Hue light configured on that collection should perform its action (for example, flash).