Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Employees / Add

  • Article
  • 4 minutes to read

Operation Information

Creates a new Employee in BambooHR.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type API Key.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint

Tip

The API Key field should be populated with an API Key that is generated against the BambooHR account that you wish to perform the actions as. See the BambooHR documentation for information about generating keys.

The API Endpoint field should be populated with the subdomain used to access your BambooHR account, as so: https://[API Endpoint].bamboohr.com.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked API Key account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
First Name firstName string The First Name of the Employee Yes None provided
Middle Name middleName string The Middle Name of the Employee No None provided
Last Name lastName string The Last Name of the Employee Yes None provided
Preferred Name preferredName string An Employees preffered name to be referred to by No None provided
Gender gender string The Employees gender No None provided
Job Title jobTitle string The Job Title of the added Employee No None provided
Work Phone workPhone string The new Employee’s Work Phone Number No None provided
Mobile Phone mobilePhone string The new Employee’s Mobile Phone Number No None provided
Work Email workEmail string The new Employee’s work email address No None provided
Department department string The Department the new Employee is a part of No None provided
Location location string The Location of the Employee at the time of addition No None provided
Division division string The Division the new Employee will be a part of No None provided
Work Phone Extension workPhoneExtension string The new Employee’s work phone extension No None provided
Can UploadPhoto canUploadPhoto boolean Controls whether photos can be uploaded No None provided
Date Of Birth dateOfBirth string The Date Time display of the new Employees date of birth No None provided
Address Line 1 address1 string The road address of the Employee No None provided
Address Line 2 address2 string If applicable the second address line of the new Employee No None provided
City city string The City the new Employee is based in No None provided
State/Province state string The State/Province or County the new Employee is based in No None provided
State/Province Code stateCode string The State/Province or County code the new Employee is based in No None provided
Status status string The new Employees status No None provided
Country country string The Country the new Employee is based from No None provided
Zip/Postal Code zipcode string The PostCode of the new Employee No None provided
Home Email homeEmail string The home email address of the new Employee No None provided
Home Phone homePhone string The home phone number of the new Employee No None provided
Hire Date hireDate string The date the new Employee was hired on No None provided
Original Hire Date originalHireDate string The orginal hire date of the new employee No None provided
Ethnicity ethnicity string The Ethinicity of the new Employee No None provided
Nationality nationality string The Nationality of the new Employee No None provided
National ID nationalId string The National ID of the new Employee No None provided

Output Parameters

Display Name ID Type Description
Outcome outcome string The Outcome of the Cloud Automation Integration
Errors errors string Any errors returned from the Cloud Automation Integration
Employee ID id number The ID of the new Employee
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document