Berke's Email Connector is a lightweight integration tool that uses templated emails from your ATS/HRIS system to send assessments and deliver reports back to you automatically. The Email Connector makes it easy to deploy a basic integration with little or no programming or IT support. We can frequently talk customers through the process of setting up the Email Connector over the phone.

Here is how the Email Connector works:

Supported Systems

Most ATS/HRIS systems can use the Email Connector. Use the flowchart below to determine if your system is supported. If you are unsure whether your system is supported, please ask your ATS/HRIS vendor or IT support team to visit this link to review the Email Connector's eligibility requirements.

Adding the Email Connector to your Berke Account

After verifying that your system is supported by the Email Connector, please contact Customer Success to enable the Email Connector. The Email Connector is an add-on to your Berke account.

Configuring Your Templated Messages

We designed the Email Connector to be as secure, flexible, and friendly as possible. The instructions below show how to format messages to the Email Connector and use the various instructions you can send. The Quickstart examples show the minimum data you must include to use each instruction.

  1. Using the example below, format an instruction block to email to the Email Connector. For example, the following instruction block will configure a new assessment, mail an invitation to the participant, and send a success message to your email address.
    {|~ ConfigureAssessmentAndSendInvitation : start ~|}
    {|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
    {|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
    {|~ FirstName : Atticus ~|}
    {|~ LastName : Finch ~|}
    {|~ SendSuccessMessage : True ~|}
    {|~ ConfigureAssessmentAndSendInvitation : end ~|}
  2. After formatting your instruction block, send the message to our Test Email Connector at [YourBerkeEmailConnectorId]@testgateway.berkeassessment.com. In order for the message to be processed, it must be from the From address registered to your Email Connector configuration. The message does not need a subject, but you can include one if you like. The Test Email Connector will scan your message, but will not create an assessment, send an invitation, etc.
     
  3. The Test Email Connector will review your message and reply to you. It will explain whether the message is properly formatted, if there are security problems, etc. If the message has problems, carefully review the returned message, then fix your message and try again.
     
  4. Once you have the format correct, you are ready to begin using the Email Connector. Next, you will send your messages to [YourBerkeEmailConnectorId]@gateway.berkeassessment.com. Like before, it must be from the From address registered to your Email Connector configuration or the Email Connector will ignore the message. This is to help ensure the security and integrity of your Berke account.
     
  5. If there is a problem with the data in a message to the Email Connector, we will return a description of the problem to the error email address specified in your Email Connector configuration.

ConfigureAssessmentAndSendInvitation Instruction Block

Configures an assessment and sends an email invitation to the participant. You must use this method to invite participants to take the assessment if you cannot set the participant's unique SourceCandidateId value.

Quickstart Example

The following demonstrates the minimum data necessary to use this instruction.

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
{|~ FirstName : Atticus ~|}
{|~ LastName : Finch ~|}
{|~ SendSuccessMessage : True ~|}
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

Full Example

The following demonstrates all of the values you can use on this instruction.

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    {|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
    {|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
    {|~ FirstName : Atticus ~|}
    {|~ LastName : Finch ~|}
    {|~ SendSuccessMessage : True ~|}
    {|~ CompleteWithinDays : 7 ~|}
    {|~ EmailMessage : Hello Atticus -,
    Below are instructions for completing an assessment. If you have questions, please contact me at Jeff@BerkeAssessment.com.
    ~ Jeff, 404-444-4444 ~|}
    {|~ EmailReportToList : BillFold@BerkeAssessment.com,MrBurns@BerkeAssessment.com,AmyPond@BerkeAssessment.com ~|}
    {|~ FromFullName : Bill Fold ~|}
    {|~ FullName : Finch, Atticus ~|}
    {|~ OnAssessmentCompleteAction : SendReportToEmailList ~|}
    {|~ ReplyToAddress : BillFold@BerkeAssessment.com ~|}
    {|~ SourceCandidateId : YourSystemCandidateId12345 ~|}
    {|~ SourceJobId : YourSystemJobCode98765 ~|}
    {|~ ConfigureAssessmentAndSendInvitation : end ~|}

Formatting

To use the ConfigureAssessmentAndSendInvitation instruction, you must start the instruction like the following:
{|~ ConfigureAssessmentAndSendInvitation : start ~|}
After starting the instruction, you must include the 5 required properties and any of the 14 optional properties. Instruction properties are formatted like the following:
{|~ Name : Data ~|}
All open instructions must be closed like the following:
{|~ ConfigureAssessmentAndSendInvitation : end ~|}
All instructions must follow the formatting guidelines above. Improperly formatted instructions will result in an error and your message will not be processed. See below for specific details of each property in the ConfigureAssessmentAndSendInvitation instruction

ConfigureAssessmentAndSendInvitation : AdministrativeEmailAddress [optional - defaulted if blank or omitted]

Email address(es) to which to send all error messages, plus success messages if enabled. To enable success messages, set [SendSuccessMessage] to True. If supplying multiple addresses, separate each address with a comma.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ AdministrativeEmailAddress : YourEmailAddress@@YourCompany.com ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : EmailAddress [required]

The assessment participant's email address

Data
Valid email address, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : FirstName [required]

First name of the assessment participant

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ FirstName : Atticus ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : LastName [required]

Last name of the assessment participant

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ LastName : Finch ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : SendSuccessMessage [optional - defaulted if blank or omitted]

Sends a success message to [AdministrativeEmailAddress] when a gateway message is successfully processed. Defaults to [True] if omitted.

Data
True or False

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ SendSuccessMessage : True ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : AdministrativeEmailAddress [optional - defaulted if blank or omitted]

Email address(es) to which to send all error messages, plus success messages if enabled. To enable success messages, set [SendSuccessMessage] to True. If supplying multiple addresses, separate each address with a comma.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : CompleteWithinDays [optional - defaulted if blank or omitted]

Sets the assessment reminder schedule. If you do not specify a value, then the default value from your company's assessment personalization settings will be used. You can remind participants up to 21 days to complete the assessment.

Data
Number, between 0 and 21

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ CompleteWithinDays : 7 ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : EmailMessage [optional - defaulted if blank or omitted]

The personal message to include in the participant's assessment invitation. If blank, then the default invitation message from your company's assessment personalization settings will be used.

Data
Multiple lines of text, up to 1000 characters, no HTML [or omit/leave it blank]

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ EmailMessage : Hello Atticus -,
Below are instructions for completing an assessment. If you have questions, please contact me at Jeff@BerkeAssessment.com.
~ Jeff, 404-444-4444 ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : EmailReportToList [optional - defaulted if blank or omitted]

If OnAssessmentCompleteAction is set to SendReportToEmailList, this property is required. Otherwise, it is not used. This field contains a comma-separated list of email addresses to whom to send the assessment report

Data
Valid email address, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ EmailReportToList : BillFold@BerkeAssessment.com,MrBurns@BerkeAssessment.com,AmyPond@BerkeAssessment.com ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : FromFullName [optional - defaulted if blank or omitted]

The full name of the person sending the assessment invitation. If blank, then the hiring manager's full name will be used.

Data
Text, up to 50 characters [or omit/leave it blank]

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ FromFullName : Bill Fold ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : FullName [optional - defaulted if blank or omitted]

Full name of the assessment participant. We recommend using FirstName and LastName, but if your system cannot split the participant's name into unique values, then we can do it for you. To use FullName, you must leave FirstName and LastName empty. Otherwise, we will ignore FullName. If we cannot find two names after splitting FullName, then the instruction will fail. We make a best effort to determine your participant's first and last name and put the names in the correct positions. For example, FirstName will be 'Atticus' if FullName is 'Finch, Atticus'. When FullName is 'Atticus Finch, Jr.', 'Finch, Jr.' will become LastName. If the system does not parse FullName perfectly, your participant can correct the name when completing the assessment.

Data
Text, up to 100 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ FullName : Finch, Atticus ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : OnAssessmentCompleteAction [optional - defaulted if blank or omitted]

Instructs the Berke system to whom to send the assessment report when the participant has completed the assessment

Data
One of the following instructions: SendReportToHiringManager, SendReportToCandidate, SendReportToEmailList, DoNothing

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ OnAssessmentCompleteAction : SendReportToEmailList ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : ReplyToAddress [optional - defaulted if blank or omitted]

The email address to which the participant can send email replies and questions. If blank, then the hiring manager's email address will be used.

Data
Valid email address, up to 50 characters, [or omit/leave it blank]

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ ReplyToAddress : BillFold@BerkeAssessment.com ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : SendSuccessMessage [optional - defaulted if blank or omitted]

Sends a success message to [AdministrativeEmailAddress] when a gateway message is successfully processed. Defaults to [True] if omitted.

Data
True or False

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ SendSuccessMessage : True ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : SourceCandidateId [optional - defaulted if blank or omitted]

A unique identifier in your system for the assessment participant. If blank, Berke will assign a default unique ID.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ SourceCandidateId : YourSystemCandidateId12345 ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}

ConfigureAssessmentAndSendInvitation : SourceJobId [optional - defaulted if blank or omitted]

The ID of the job you want the participant to be assessed against. If blank, Berke will default to your company's default assessment. You can set your default job and assign your job ID values to Berke jobs in the Settings | API | Job Assignments section of the Berke site.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessmentAndSendInvitation : start ~|}
    ....
{|~ SourceJobId : YourSystemJobCode98765 ~|}
    ....
{|~ ConfigureAssessmentAndSendInvitation : end ~|}
#####################################
ConfigureAssessment Instruction Block
#####################################
Configures a new assessment if SourceCandidateId is empty or if SourceCandidateId is not in use. If SourceCandidateId has a value and an assessment is already assigned to the SourceCandidateId value, then no action will be taken.

Quickstart Example

Demonstrates the minimum data necessary to use this instruction:
{|~ ConfigureAssessment : start ~|}
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
{|~ FirstName : Atticus ~|}
{|~ LastName : Finch ~|}
{|~ SendSuccessMessage : True ~|}
{|~ ConfigureAssessment : end ~|}

Full Example

Demonstrates all of the values you can use on this instruction:
{|~ ConfigureAssessment : start ~|}
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
{|~ FirstName : Atticus ~|}
{|~ LastName : Finch ~|}
{|~ SendSuccessMessage : True ~|}
{|~ CompleteWithinDays : 7 ~|}
{|~ EmailMessage : Hello Atticus -,
Below are instructions for completing an assessment. If you have questions, please contact me at Jeff@BerkeAssessment.com.
~ Jeff, 404-444-4444 ~|}
{|~ EmailReportToList : BillFold@BerkeAssessment.com,MrBurns@BerkeAssessment.com,AmyPond@BerkeAssessment.com ~|}
{|~ FullName : Finch, Atticus ~|}
{|~ OnAssessmentCompleteAction : SendReportToEmailList ~|}
{|~ SourceCandidateId : YourSystemCandidateId12345 ~|}
{|~ SourceJobId : YourSystemJobCode98765 ~|}
{|~ ConfigureAssessment : end ~|}

Formatting

To use the ConfigureAssessment instruction, you must start the instruction like the following:
{|~ ConfigureAssessment : start ~|}
After starting the instruction, you must include the 5 required properties and any of the 12 optional properties. Instruction properties are formatted like the following:
{|~ Name : Data ~|}
All open instructions must be closed like the following:
{|~ ConfigureAssessment : end ~|}
All instructions must follow the formatting guidelines above. Improperly formatted instructions will result in an error and your message will not be processed. See below for specific details of each property in the ConfigureAssessment instruction

ConfigureAssessment : AdministrativeEmailAddress [optional - defaulted if blank or omitted]

Email address(es) to which to send all error messages, plus success messages if enabled. To enable success messages, set [SendSuccessMessage] to True. If supplying multiple addresses, separate each address with a comma.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : EmailAddress [required]

The assessment participant's email address

Data
Valid email address, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : FirstName [required]

First name of the assessment participant

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ FirstName : Atticus ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : LastName [required]

Last name of the assessment participant

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ LastName : Finch ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : SendSuccessMessage [optional - defaulted if blank or omitted]

Sends a success message to [AdministrativeEmailAddress] when a gateway message is successfully processed. Defaults to [True] if omitted.

Data
True or False

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ SendSuccessMessage : True ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : AdministrativeEmailAddress [optional - defaulted if blank or omitted]

Email address(es) to which to send all error messages, plus success messages if enabled. To enable success messages, set [SendSuccessMessage] to True. If supplying multiple addresses, separate each address with a comma.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : CompleteWithinDays [optional - defaulted if blank or omitted]

Sets the assessment reminder schedule. If you do not specify a value, then the default value from your company's assessment personalization settings will be used. You can remind participants up to 21 days to complete the assessment.

Data
Number, between 0 and 21

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ CompleteWithinDays : 7 ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : EmailMessage [optional - defaulted if blank or omitted]

The personal message to include in the participant's assessment invitation. If blank, then the default invitation message from your company's assessment personalization settings will be used.

Data
Multiple lines of text, up to 1000 characters, no HTML [or omit/leave it blank]

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ EmailMessage : Hello Atticus -,
Below are instructions for completing an assessment. If you have questions, please contact me at Jeff@BerkeAssessment.com.
~ Jeff, 404-444-4444 ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : EmailReportToList [optional - defaulted if blank or omitted]

If OnAssessmentCompleteAction is set to SendReportToEmailList, this property is required. Otherwise, it is not used. This field contains a comma-separated list of email addresses to whom to send the assessment report

Data
Valid email address, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ EmailReportToList : BillFold@BerkeAssessment.com,MrBurns@BerkeAssessment.com,AmyPond@BerkeAssessment.com ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : FullName [optional - defaulted if blank or omitted]

Full name of the assessment participant. We recommend using FirstName and LastName, but if your system cannot split the participant's name into unique values, then we can do it for you. To use FullName, you must leave FirstName and LastName empty. Otherwise, we will ignore FullName. If we cannot find two names after splitting FullName, then the instruction will fail. We make a best effort to determine your participant's first and last name and put the names in the correct positions. For example, FirstName will be 'Atticus' if FullName is 'Finch, Atticus'. When FullName is 'Atticus Finch, Jr.', 'Finch, Jr.' will become LastName. If the system does not parse FullName perfectly, your participant can correct the name when completing the assessment.

Data
Text, up to 100 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ FullName : Finch, Atticus ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : OnAssessmentCompleteAction [optional - defaulted if blank or omitted]

Instructs the Berke system to whom to send the assessment report when the participant has completed the assessment

Data
One of the following instructions: SendReportToHiringManager, SendReportToCandidate, SendReportToEmailList, DoNothing

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ OnAssessmentCompleteAction : SendReportToEmailList ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : SendSuccessMessage [optional - defaulted if blank or omitted]

Sends a success message to [AdministrativeEmailAddress] when a gateway message is successfully processed. Defaults to [True] if omitted.

Data
True or False

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ SendSuccessMessage : True ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : SourceCandidateId [optional - defaulted if blank or omitted]

A unique identifier in your system for the assessment participant. If blank, Berke will assign a default unique ID.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ SourceCandidateId : YourSystemCandidateId12345 ~|}
    ....
{|~ ConfigureAssessment : end ~|}

ConfigureAssessment : SourceJobId [optional - defaulted if blank or omitted]

The ID of the job you want the participant to be assessed against. If blank, Berke will default to your company's default assessment. You can set your default job and assign your job ID values to Berke jobs in the Settings | API | Job Assignments section of the Berke site.

Data
Text, up to 50 characters

Example Usage

{|~ ConfigureAssessment : start ~|}
    ....
{|~ SourceJobId : YourSystemJobCode98765 ~|}
    ....
{|~ ConfigureAssessment : end ~|}

SendInvitation Instruction Block

Sends an email invitation to the participant whose assessment is related to the SourceCandidateId value. You must know the participant's SourceCandidateId value to use this instruction. This instruction cannot be used before the participant's assessment has been configured.

Quickstart Example

Demonstrates the minimum data necessary to use this instruction:

{|~ SendInvitation : start ~|}
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
{|~ SendSuccessMessage : True ~|}
{|~ SourceCandidateId : YourSystemCandidateId12345 ~|}
{|~ SendInvitation : end ~|}

Full Example

Demonstrates all of the values you can use on this instruction

{|~ SendInvitation : start ~|}
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
{|~ SendSuccessMessage : True ~|}
{|~ SourceCandidateId : YourSystemCandidateId12345 ~|}
{|~ EmailMessage : Hello Atticus -,
Below are instructions for completing an assessment. If you have questions, please contact me at Jeff@BerkeAssessment.com.
~ Jeff, 404-444-4444 ~|}
{|~ FromFullName : Bill Fold ~|}
{|~ ReplyToAddress : BillFold@BerkeAssessment.com ~|}
{|~ SendInvitation : end ~|}

Formatting

To use the SendInvitation instruction, you must start the instruction like the following: {|~ SendInvitation : start ~|} After starting the instruction, you must include the 4 required properties and any of the 8 optional properties. Instruction properties are formatted like the following: {|~ Name : Data ~|} All open instructions must be closed like the following: {|~ SendInvitation : end ~|}

All instructions must follow the formatting guidelines above. Improperly formatted instructions will result in an error and your message will not be processed. See below for specific details of each property in the SendInvitation instruction

SendInvitation : AdministrativeEmailAddress [optional - defaulted if blank or omitted]

Email address(es) to which to send all error messages, plus success messages if enabled. To enable success messages, set [SendSuccessMessage] to True. If supplying multiple addresses, separate each address with a comma.

Data
Text, up to 50 characters

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : EmailAddress [required]

The assessment participant's email address

Data
Valid email address, up to 50 characters, [or omit/leave it blank]

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ EmailAddress : AtticusFinch@ExcellentPeople.com ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : SendSuccessMessage [optional - defaulted if blank or omitted]

Sends a success message to [AdministrativeEmailAddress] when a gateway message is successfully processed. Defaults to [True] if omitted.

Data
True or False

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ SendSuccessMessage : True ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : SourceCandidateId [required]

A unique identifier in your system for the assessment participant.

Data
Text, up to 50 characters

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ SourceCandidateId : YourSystemCandidateId12345 ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : AdministrativeEmailAddress [optional - defaulted if blank or omitted]

Email address(es) to which to send all error messages, plus success messages if enabled. To enable success messages, set [SendSuccessMessage] to True. If supplying multiple addresses, separate each address with a comma.

Data
Text, up to 50 characters

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ AdministrativeEmailAddress : YourEmailAddress@YourCompany.com ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : EmailMessage [optional - defaulted if blank or omitted]

The personal message to include in the participant's assessment invitation. If blank, then the default invitation message from your company's assessment personalization settings will be used.

Data
Multiple lines of text, up to 1000 characters, no HTML, [or omit/leave it blank]

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ EmailMessage : Hello Atticus -,
Below are instructions for completing an assessment. If you have questions, please contact me at Jeff@BerkeAssessment.com.
~ Jeff, 404-444-4444 ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : FromFullName [optional - defaulted if blank or omitted]

The full name of the person sending the assessment invitation. If blank, then the hiring manager's full name will be used.

Data
Text, up to 50 characters [or omit/leave it blank]

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ FromFullName : Bill Fold ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : ReplyToAddress [optional - defaulted if blank or omitted]

The email address to which the participant can send email replies and questions. If blank, then the hiring manager's email address will be used.

Data
Valid email address, up to 50 characters [or omit/leave it blank]

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ ReplyToAddress : BillFold@BerkeAssessment.com ~|}
    ....
{|~ SendInvitation : end ~|}

SendInvitation : SendSuccessMessage [optional - defaulted if blank or omitted]

Sends a success message to [AdministrativeEmailAddress] when a gateway message is successfully processed. Defaults to [True] if omitted.

Data
True or False

Example Usage

{|~ SendInvitation : start ~|}
    ....
{|~ SendSuccessMessage : True ~|}
    ....
{|~ SendInvitation : end ~|}

For Best Results, Use Plaintext Messages

If possible, the system sending your message should use [Content Type: text/plain] instead of [Content Type: text/html]. When we receive a message that contains both plain text and HTML text, we use the plain version of because it is simpler and more reliable to parse. We only use the HTML version of your message if the text version is empty. In that case, we strip the HTML tags and convert entities (like  ) to their character-equivalent. While this works in practice, we cannot predict in all cases whether your content is being received as you intended.

If your system must send HTML content, then minimize the HTML content as much as possible. Try to format your message as close to a plain text message as you can.

If you are unsure what to do, give it a try and see if it works. If you have problems or unexpected results please contact the Berke Support team at Support@BerkeAssessment.com. We may have some suggestions to correct the issue.

Email Connector Terms of Use

Berke takes all reasonable security measures to ensure that your company and participant data remains confidential. However, email is not a highly secure transmission medium. Though we take all possible precautions to ensure the integrity of your messages, we cannot be 100% certain it has not be intercepted or modified en-route or that the message originated at your company.

Therefore, you must not under any circumstances send sensitive personal information to the Email Connector, including, but not limited to, Social Security Numbers (SSN), credit card numbers, bank routing information, etc.

If you have any questions or concerns about this policy or the security of your company data, do not hesitate to contact the Berke Support team at Support@BerkeAssessment.com or speak with a qualified security consultant.

Unsolicited assessment invitations cannot be sent under any condition. All assessment invitations must be to users who have a relationship with your company and who have willingly provided their email address to you. Sending unsolicited invitations is SPAM. Sending unsolicited messages can result in immediate termination of your Berke account.

Any use of the Email Connector indicates your agreement with the overall Berke Terms of Use.