Events
Events are our way of letting you know when something interesting happens in your ATS. When an interesting event occurs, we create a new Event object. For example, when an onboarding new hire file is completed, we create a new-hire-file.completed event.
Events occur when the state of a resource changes. The state of that resource at the time of the change is embedded in the event's data field. For example, a new-hire-file.completed event will contain a new hire file.
The event object
Attributes
id guid
Unique identifier for the object.
data hash
Object containing data associated with the event.
occurredOn date
Date the the event occurred.
type string
Description of the event (e.g., new-hire-file.completed).
version string
The KeldairHR API version used to render data.
Types of events
This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.
You'll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against.
Event
new-hire-file.completed data.object is a new hire file
Occurs whenever an onboarding new hire file has been marked completed.
Event payloads
The new hire file object
Attributes
id long
Unique identifier for the object.
firstName string
First name of the new hire.
larstName string
Last name of the new hire.
emailAddress string
Email address of the new hire.
phoneNumber PhoneNumber
Phone number of the new hire.
address Address
Address of the new hire.
appliedDate Date
Date the new hire applied to the job.
hiredDate Date
Date the new hire was hired.
externalOpeningId string
Id of third party job opening.
fields Onboarding.Field[]
All fields configured in the new hire record configuration section of onboarding in the ATS.
demographics Onboarding.Demographics
Demographic information provided by both the new hire and the employer.
emergencyContacts Onboarding.Contact[]
All emergency contacts provided by the new hire.
directDeposits Onboarding.DirectDeposit[]
All direct deposit forms provided by the new hire.
forms Onboarding.Forms
Various forms provided by the new hire.
Common Data Types
Address
A hash containing typical address fields.
streetAddress string
streetAddress2 string
city string
province string
postalCode string
Date
A string in the format 2022-02-23T09:46:43-05:00.
PhoneNumber
A string in the E.164 format.
Onboarding.Field
A field from the new hire record.
name string
The name of the field.
type string
The type of the field, possible values: Ats, NewHire, CompanyStandard, CompanyUnique, PdfForm.
If the field is of type PdfForm and the form control for that field was a grouped form control (i.e. radio button group or checkbox group) that allowed multiple answers, then multiple answers will be separated by a | if multiple answers were provided. For a single checkbox, values of True or False will be used to represent whether or not the checkbox was checked.
value string
The value of the field.
Onboarding.Demographics
Demographic information provided by both the new hire and the employer.
address Address
Address of the new hire.
appliedDate Date
Date the new hire applied to the job.
dateOfBirth Date
Date the new hire was born.
department string
The department the job is in.
employeeId string
The employee id.
employeeType string
The employee type.
firstName string
First name of the new hire.
hireType string
The hire type.
homePhone PhoneNumber
The home phone number of the new hire.
job string
The job hired for.
lastName string
Last name of the new hire.
location string
The location of the job.
middleInitial string
Middle initial of the new hire.
mobilePhone PhoneNumber
The mobile phone number of the new hire.
personalEmail string
Personal email address of the new hire.
mobilePhone PhoneNumber
Mobile phone number of the new hire.
ssn string
Social security number of the the new hire.
suffix string
Suffix of the new hire.
workEmailAddress string
Work email address of the new hire.
workPhone PhoneNumber
Work phone number of the new hire.
workStartDate Date
Work start date of the new hire.
Onboarding.Contact
An emergency contact provided by the new hire.
email string
The email of the emergency contact.
homePhone PhoneNumber
The home phone number of the emergency contact.
mobilePhone PhoneNumber
The mobile phone number of the emergency contact.
name string
The name of the emergency contact.
notes string
Extra notes about the emergency contact.
relation string
The relationship of the emergency contact to the new hire.
workPhone PhoneNumber
The work phone number of the emergency contact.
Onboarding.DirectDeposit
An direct deposit form provided by the new hire.
id long
Unique identifier for the object.
institutionName string
The institution (i.e a bank or credit union) to deposit funds to.
accountType string
Account type: possible values: Checking, Savings.
routingNumber string
Nine-digit routing number of the Institution.
dollarAmount decimal
Amount in dollars that should be deposited into account.
percentageAmount int
Amount in percent (0-100) that should be deposited into account.
allRemaining bool
Indicated that any remining dollars or percentage should be deposited to this account.
Onboarding.Forms
Various forms provided by the new hire.
w4 Onboarding.W4
W4 form.
Onboarding.W4
W4 form.
filingStatus string
The answer to Step 1 box c.
multipleJobsOrSpouseWorks bool
The answer to Step 2.
childTaxCredit decimal
The answer to step 3 box 1.
dependentCredit decimal
The answer to step 3 box 2.
totalCredits decimal
The answer to step 3 box 3.
otherIncome decimal
The answer to step 4 box a.
deductions decimal
The answer to step 4 box b.
extraWithholding decimal
The answer to step 4 box c.
Updated 9 months ago