Webhooks

Team Engine now has the capability to send applicant information to a webhook.

What it is?

When an applicant is moved into a status (interested to employed) we can send a web request to a URL with that applicants information collected during the application.

Why would I use it?

If you want to move Team Engine applicants and all their information into another system, like an HRIS, to reduce the manual repetitive work you are currently doing to transfer information between the two systems.

How to set this up:

Go to "Company Settings" and click on "Connect to Webhook"

Fill out the relevant information for your webhook:

Required Information:

Status Change to Send Applicant Data: the status you move an applicant to that triggers the data to be send to the webhook

Post URL: a publicly accessible web URL (often your IT or technical user would set up a service to receive this information.

Optional Information:

Key/Value Pair: Additional information to be included in the webhook request. (This might include an external customer ID, or other required static data)

What applicant information will Team Engine be sending to the webhook?

Data Fields

General Notes:

Optional data fields will always have a value or null
Optional array fields will always return an array, which will be empty if there is no nested data
All dates are provided as formatted ISO 8601 strings

Applicant

Field	Type	Required?	Example
applicantId	string	true	00aCh6pfs39JasV71fizId8C9o	Applicant hash, used for identification in Team Engine
firstName	string	true	Jane	Applicant’s first name, always provided
lastName	string	true	Doe	Applicant’s last name, always provided
phoneNumber	string \| null	false	+15556667777	Applicant’s phone number, provided in E.164 format
email	string \| null	false	jane.doe@email.com	Applicant’s email
startDate	string \| null	false	2023-10-16T19:19:09.193Z	Applicant’s start date, provided as an ISO 8601 string
jobTitle	string	true	Crew Leader	Title of job Applicant has applied to
resumeUrl	string \| null	false	https://link-to-resume.com/Jane_Resume.pdf	A url to download the Applicant’s resume Note: Resumes should be downloaded and re-uploaded, this link should not be used to continually access the resume
languagePreference	string \| null	false	en	Applicant’s selected language preference, in ISO 639 standard format (two-letter code)
address	object	true		see below for address field details
workHistory	array	true		see below for workHistory details
education	array	true		see below for education details

Work History

Field	Type	Required?	Example
jobTitle	string \| null	false	Crew Member	Job title of previous position
company	string \| null	false	Shell Company LLC	Company of previous position
startDate	string \| null	false	2021-10-16T19:19:09.193Z	Start date at previous position, provided as an ISO 8601 string
endDate	string \| null	false	2022-10-16T19:19:09.193Z	End date at previous position, provided as an ISO 8601 string

Education

Field	Type	Required?	Example
name	string \| null	false	SUNY Oneonta	Name of educational program or institution
startDate	string \| null	false	2020-10-16T19:19:09.193Z	Start date, provided as an ISO 8601 string
endDate	string \| null	fasle	2022-10-16T19:19:09.193Z	End date, provided as an ISO 8601 string
graduated	boolean \| null	false	true	Graduated from program?
educationLevel	‘fourYearCollege' \| ‘twoYearCollege' \| 'highSchool' \| ’jobTraining’ \| null	false	twoYearCollege	Type of educational program: Four Year College Two Year College Highschool Job Training
address	object	true		see below for address field details

Address

Field	Type	Required?	Example
addressLine1	string \| null	false	123 N Main St	Building number and street name
addressLine2	string \| null	false	Suite 501	Street Address second line, typically the suite or apartment number
city	string \| null	false	Oneonta	City, town or village name
state	string \| null	false	NY	State, provided as two letter state abbreviation
zipCode	string \| null	false	12345-6789	Zip code, provided typically as 5 digits, can include a plus 4 suffix code