n8n-nodes-brighthr

This is an n8n community node that lets you use BrightHR in your n8n workflows with OAuth2 authentication.

BrightHR is an HR software platform that helps manage employees, absences, time off, and other HR-related tasks.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Manual Installation

1. Go to your n8n installation directory
2. Run: npm install n8n-nodes-brighthr
3. Restart n8n

Operations

This node supports the following operations:

Employee

• Get: Retrieve a single employee by ID
• Get Many: Retrieve multiple employees
• Create: Create a new employee
• Update: Update an existing employee

Company

• Get: Retrieve company information by ID
• Get Many: Retrieve all companies

Absence

• Get: Retrieve a single absence by ID
• Get Many: Retrieve multiple absences

Time Off

• Get: Retrieve a single time off request by ID
• Get Many: Retrieve multiple time off requests

Credentials

To use this node, you need to set up OAuth2 credentials with BrightHR:

1. Create a BrightHR App:

   • Go to the BrightHR Developer Portal
   • Create a new application
   • Note your Client ID and Client Secret

2. Configure OAuth2 in n8n:

   • In n8n, create new credentials of type "BrightHR OAuth2 API"
   • Enter your Client ID and Client Secret
   • Click "Connect my account"
   • You'll be redirected to BrightHR to login with your username and password
   • After authorization, you'll be redirected back to n8n

3. OAuth2 Details:

   • Authorization URL: https://login.brighthr.com/connect/authorize
   • Token URL: https://login.brighthr.com/connect/token
   • Scopes: openid profile email company:read employee:read employee:write offline_access

Compatibility

• Minimum n8n version: 0.196.0
• Tested with n8n version: 1.0.0+

Usage

Basic Example: Get All Employees

1. Add the BrightHR node to your workflow
2. Select "Employee" as the resource
3. Select "Get Many" as the operation
4. Enter your Company ID
5. Configure the credentials (OAuth2)
6. Execute the node

Authentication Flow

Unlike the previous version that required manual Client Secret entry, this version uses OAuth2 authentication:

1. When you add credentials, you'll enter your Client ID and Client Secret (from your BrightHR developer app)
2. Click "Connect my account"
3. You'll be redirected to BrightHR's login page
4. Login with your BrightHR username and password
5. Authorize the app to access your BrightHR data
6. You'll be redirected back to n8n with a valid token

The OAuth2 flow provides:

• Secure authentication without exposing passwords
• Automatic token refresh
• Proper scope management
• Better security practices

Resources

• n8n community nodes documentation
• BrightHR API documentation
• BrightHR OAuth2 documentation

Version History

1.0.0

• Initial release with OAuth2 authentication
• Support for Employee, Company, Absence, and Time Off resources
• User-friendly login flow via OAuth2

License

MIT