Some systems, such as the widely used ATS PageUp and it's onboarding function, don't have an API for integrating to vSure, but they do offer email triggers.
To allow single data entry onboarding, we have built a "trigger onboard from email" feature.
1.0 Register for "email to vSure auto-onboarding"
To manage the risk of SPAM, this is a feature that needs to be "turned on". We "white-list" specific email senders / domains to be able to utilise this feature.
Please use the Zendesk "Submit a Request" above or click here and please include:
- The vSure client company name;
- Contact name;
- Contact Email;
- Overview of what system you will use to trigger the emails;
- Your sender email Address(es) / domain for white-listing;
1.1 The Account Key
First you need to know your account key, which is provided on the My Account Screen (see below). vSure will use this key to add the employee/contractor/candidate to the account.
1.2 The TO email address
An employee/contractor/candidate can be added by sending an email to:
onboarding-<accountkeyid>@vsure.com.au
where you replace <accountkeyid> with the specific account key.
1.3 Email Subject
The email subject must be: "Onboarding Data" (no quotes).
2.0 Email body
vSure accepts two formats for the email body: JSON and Tags
2.1 Tags / List format - email body
We use square brackets to define the available field in vSure.
At least one of [Email] and/or [Mobile] are required. All other fields are optional.
[GivenName] John
[FamilyName] Smith
[DOB] YYYY-MM-DD
[Email] XXXXXXXXXXXX
[Mobile] XXXXXXXXXX
[SendType] Both
[EmploymentStatus] Current
[EmployeeID] XXXXX
[StartDate] YYYY-MM-DD
[Location] XXXXX
[Group] XXXXX
The following is the details of the data:
Email – string
The email address of the visa holder.
Mobile – string
The Australian mobile number of the visa holder. Format 0000000000.
SendType – string (optional)
This defines how the Right To Work self-Onboard is sent to the candidate/employee.
Options: Email; SMS; Both
The system defaults to:
- Both if both Email and Mobile are included in the email text;
- Email if only email address is included in the email text;
- SMS if only Mobile is present.
EmploymentStatus – string (optional)
This defines which tab the employee/contractor/candidate is added to in vSure.
Options: Current; Prospective
The system defaults to current if this tag is missing.
GivenName - string (optional)
The given names of the visa holder.
FamilyName - string (optional)
The family name of the visa holder.
DOB - string (Format: "YYYY-MM-DD") (optional)
The date of birth of the visa holder.
EmployeeID – string (optional)
The employee ID of the visa holder.
StartDate – string (Format: "YYYY-MM-DD") (optional)
The start working date of the visa holder.
Location – string (optional)
The location of the visa holder.
Group – string (optional)
The group of the visa holder.
2.2 JSON format - email body
Our email onboarding system accepts JSON format:
{
"given_names":"John",
"family_name":"Smith",
"date_of_birth":"YYYY-MM-DD",
"email":"XXXXXXXXXX",
"mobile_number":"XXXXXXXXXX",
"SendType":"Both",
"employment_status": "current"
"employee_id":"XXXXX",
"start_date":"YYYY-MM-DD",
"location":"XXXXXXXXXX",
"group":"XXXXXXXXXX",
}
The following is the details of the data:
email – string
The email address of the visa holder.
mobile_number – string
The Australian mobile number of the visa holder. Format 0000000000.
SendType – string (optional)
This defines how the Right To Work self-Onboard is sent to the candidate/employee.
Options: Email; SMS; Both
The system defaults to:
- Both if both Email and Mobile are included in the email text;
- Email if only email address is included in the email text;
- SMS if only Mobile is present.
employment_status – string (optional)
This defines which tab the employee/contractor/candidate is added to in vSure.
Options: current; prospective
The system defaults to current if this tag is missing.
given_names - string (optional)
The given names of the visa holder.
family_name - string (optional)
The family name of the visa holder.
date_of_birth - string (Format: "YYYY-MM-DD") (optional)
The date of birth of the visa holder.
employee_id – string (optional)
The employee ID of the visa holder.
start_date – string (Format: "YYYY-MM-DD") (optional)
The start working date of the visa holder.
location – string (optional)
The location of the visa holder.
group – string (optional)
The group of the visa holder.