Rival Help CenterRecruit

Rival Workflow integration

To personalize the onboarding experience for the hire, Rival Workflow requires some background information before it can launch the onboarding process. If your ATS does not, or cannot track all of this information, a recruiter can supply the information in Rival Workflow.

Your ATS requests a security token from Rival Workflow to use in subsequent calls. Rival Workflow validates the security token request and makes sure the new hired employee is not a duplicate.

These are the parameters your ATS should post to Rival Workflow.

ParameterDescription
PartnerKeyA key Rival gives to each partner. Points to that partner’s data in a shared database.
SharedSecretA shared secret used, to along with the RETURN_ADDRESS, to authenticate the request.
LifesuiteCodeA code to identify the Rival Workflow customer that was entered as part of the customer configuration. Rival Workflow validates that it is pointing to the right customer to make sure there has been no misconfiguration.
ClassThe class of this service that was entered as part of the configuration. Staging, Prod, Test. Rival Workflow uses this to validate it is pointed to the right class to make sure there had been no misconfiguration.
ATSNameRival Workflow stores this so that it can be placed in the audit notes.
RecruiterNameRival Workflow stores this so that it can be placed in the audit notes.
RecruiterIDAn ID to identify the recruiter. Reserved for future use.
ATSCandidateID

ID that your ATS will use to identify the newly hired employee. This key must be immutable with respect to the newly hired employee for this job. Rival Workflow uses this ID to determine whether the employee has been already imported.

If the candidate were subsequently hired into a different job, Rival Workflow would expect a different ATSCandidateID.

Rival Workflow:

  • Returns this ID, together with the AuthenticationToken when it returns the user to your ATS.
  • Stores this ID with the employee event. Rival Workflow does not allow two events to be created with the same ATSCandidateID.