About this integration
Automated employment reference checks and candidate verification. Use it from the workflow canvas with no custom glue script required.
This integration exposes 8 triggers, 22 search modules and 19 actions as workflow nodes. Authentication uses oauth authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Open API - API Key.
Prefer the interactive builder form? Open it on the app page.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
Open API - API Key | password | Get your API key by requesting Open API access from Xref (your account must be onboarded for API). After approval, Xref will provide a Sandbox API Key (and production access as needed). |
Use it in workflow automation
Start with Watch Checks, then add Add an Unusual Activity Note.
The canvas below runs Watch Checks into Add an Unusual Activity Note — watch the video, then drop a node onto the canvas.
Select the Watch Checks trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create a Check with Referees as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 27 ready-made modules for HR work — each run logs its inputs and outputs for debugging.
Xref workflow on the canvas: Watch Checks then Create a Check with Referees
Triggers, searches and actions
Use the tables below to inspect Xref's 8 triggers, 22 search modules, and 19 actions.
Triggers
8 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Checks
- Watch Criteria
- Watch Events
- Watch Hiring Accounts
- Watch Logs
Searches
Fetch data on demand using 22 search modules that query the app during a run.
- Get a Check
- Get a Check's Lifecycle
- Get a Criterion
- Get a Log
- Get an Employer
Actions
19 action modules cover the full range of create, update, and delete operations.
- Add an Unusual Activity Note
- Add an Unusual Activity Resolution
- Add Company Domains
- Cancel a Check
- Create a Check
Explore the fields available for each Xref trigger, search, and action.
Triggers
| Field | Type |
|---|---|
ID | number |
Integration | text |
Integration sub | text |
Requested | date |
Requester | object |
ID | number |
First name | text |
Last name | text |
Email | text |
URL | text |
Candidate | object |
First name | text |
Last name | text |
Email | text |
Xref | object |
Role | text |
State | text |
State last updated | date |
Criterion | object |
Referees | array |
URL | text |
| Field | Type |
|---|---|
ID | number |
Base ID | text |
Name | text |
Min years | number |
Min referees | number |
Created on | date |
Created by | text |
Note to candidate | text |
Note to referee | text |
Mappings | array |
URL | text |
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
Date created | date |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
ID | number |
Created | date |
Method | text |
Endpoint | text |
Status | number |
Event | text |
URL | text |
| Field | Type |
|---|---|
ID | number |
Title | text |
Questions | array |
URL | text |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
ID | number |
First name | text |
Last name | text |
Email | text |
Permissions | array |
URL | text |
Searches
| Field | Type |
|---|---|
Check ID | choice |
| Field | Type |
|---|---|
ID | number |
Integration | text |
Integration sub | text |
Requested | date |
Requester | object |
ID | number |
First name | text |
Last name | text |
Email | text |
URL | text |
Candidate | object |
First name | text |
Last name | text |
Email | text |
Company | object |
ID | number |
Xref | object |
ID | number |
Role | text |
State | text |
State last updated | text |
Criterion | object |
Referees | array |
Timeline gaps | array |
Price | object |
Earliest timeline date | object |
Latest timeline date | object |
URL | text |
| Field | Type |
|---|---|
Check ID | choice |
Limit | number |
| Field | Type |
|---|---|
User ID | number |
User type | text |
User name | text |
Action | text |
Action arg 1 | text |
Action arg 2 | text |
Action arg 3 | text |
Action date | text |
Translate | boolean |
IP address | text |
Browser | text |
Location | text |
City | text |
Country | text |
Isp | text |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Base ID | number |
Name | text |
Min years | number |
Min referees | number |
Created on | date |
Created by | text |
Note to candidate | text |
Note to referee | text |
Mappings | array |
URL | text |
| Field | Type |
|---|---|
Log ID | choice |
| Field | Type |
|---|---|
ID | number |
Created | date |
IP | text |
Method | text |
Endpoint | text |
Status | number |
Event | text |
Request params | text |
Request body | text |
Response body | text |
URL | text |
| Field | Type |
|---|---|
Employer Email | choice |
| Field | Type |
|---|---|
First name | text |
Last name | text |
Email |
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
Binary | choice |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
Title | text |
Questions | array |
URL | text |
| Field | Type |
|---|---|
Check IDRequired | choice |
Attachment IDRequired | text |
Binary | choice |
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
| Field | Type |
|---|---|
URL | text |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | number |
First name | text |
Last name | text |
Email | |
Permissions | array |
URL | text |
| Field | Type |
|---|---|
Credits remaining | number |
| Field | Type |
|---|---|
States | choice |
Search | text |
Requester | choice |
Date Start | date |
Date End | date |
Unread Only | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Integration | text |
Integration sub | text |
Requested | date |
Requester | object |
ID | number |
First name | text |
Last name | text |
Email | text |
URL | text |
Candidate | object |
First name | text |
Last name | text |
Email | text |
Xref | object |
Role | text |
State | text |
State last updated | date |
Criterion | object |
Referees | array |
URL | text |
| Field | Type |
|---|---|
Email domains | array |
| Field | Type |
|---|---|
Search | text |
Include Partner Criteria | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Base ID | text |
Name | text |
Min years | number |
Min referees | number |
Created on | date |
Created by | text |
Note to candidate | text |
Note to referee | text |
Mappings | array |
URL | url |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
First name | text |
Last name | text |
Email |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
Type | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Created | date |
Method | text |
Endpoint | text |
Status | number |
Event | text |
URL | text |
| Field | Type |
|---|---|
Search | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Title | text |
Questions | array |
URL | text |
| Field | Type |
|---|---|
Check ID | choice |
Limit | number |
| Field | Type |
|---|---|
Name | text |
Email | text |
Status | text |
Viewed | boolean |
URL | text |
Company name | text |
Attachmens | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | number |
Name | text |
| Field | Type |
|---|---|
Search | text |
Limit | number |
| Field | Type |
|---|---|
ID | number |
First name | text |
Last name | text |
Email | |
Permissions | array |
URL | text |
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
| Field | Type |
|---|---|
Candidate | object |
ID | number |
Name | text |
Position | text |
Verb | text |
Modifications | array |
Email | text |
Phone number | text |
Organisation | text |
Answers | array |
Referee | object |
ID | number |
Name | text |
Position | text |
Organisation | text |
Date answered | text |
Email | text |
Phone number | text |
Uploaded PDF URL | text |
Uploaded PDF title | text |
Candidate position | text |
Actions
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
CommentsRequired | text |
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
ResolutionRequired | choice |
| Field | Type |
|---|---|
Email Domains | array |
Email Domain | text |
| Field | Type |
|---|---|
Detail | text |
| Field | Type |
|---|---|
Check ID | choice |
| Field | Type |
|---|---|
Detail | text |
| Field | Type |
|---|---|
Role | text |
Employer | object |
Email | choice |
Candidate | object |
First Name | text |
Last Name | text |
Email | |
Phone | text |
Criterion | object |
ID | choice |
Minimum Referees | number |
Minimum Years | number |
Note to Candidate | text |
Note to Referee | text |
Gap | object |
Custom ID | number |
Hiring Account | choice |
| Field | Type |
|---|---|
ID | number |
Requested | date |
Requester | object |
ID | number |
First name | text |
Last name | text |
Email | text |
URL | text |
Candidate | object |
First name | text |
Last name | text |
Email | text |
Xref | object |
Role | text |
State | text |
State last updated | text |
Criterion | object |
Referees | array |
Price | object |
Hiring account | object |
URL | text |
Custom ID | number |
| Field | Type |
|---|---|
RoleRequired | text |
CandidateRequired | object |
First Name | text |
Last Name | text |
Email | |
Phone | text |
IP Address | text |
Employer | object |
Email | choice |
Criterion | object |
ID | choice |
Minimum Referees | number |
Note to Candidate | text |
Note to Referee | text |
Referees | array |
Custom ID | number |
| Field | Type |
|---|---|
ID | number |
Requested | date |
Requester | object |
ID | number |
First name | text |
Last name | text |
Email | text |
URL | text |
Candidate | object |
First name | text |
Last name | text |
Email | text |
Xref | object |
Role | text |
State | text |
State last updated | text |
Criterion | object |
Referees | array |
URL | text |
Price | object |
Value | number |
Currency | text |
Candidate URL | text |
Custom ID | number |
| Field | Type |
|---|---|
Requirement NameRequired | text |
Minimum RefereesRequired | number |
Minimum YearsRequired | number |
Note to Candidate | text |
Note to Referee | text |
Gap Definition | object |
UnitRequired | text |
ValueRequired | number |
Questionnaire Type Mappings | array |
URLRequired | url |
| Field | Type |
|---|---|
ID | number |
Name | text |
Min years | number |
Min referees | number |
Created on | date |
Created by | text |
Note to candidate | text |
Note to referee | text |
Mappings | array |
URL | text |
| Field | Type |
|---|---|
EmailRequired | |
First Name | text |
Last Name | text |
| Field | Type |
|---|---|
First name | text |
Last name | text |
Email |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Detail | text |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Detail | text |
| Field | Type |
|---|---|
Detail | text |
| Field | Type |
|---|---|
Check ID | choice |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Company NameRequired | text |
Email DomainsRequired | array |
Email Domain | text |
Client IDRequired | text |
Client SecretRequired | text |
Process Unusual Activity | boolean |
| Field | Type |
|---|---|
Client authorization code | text |
| Field | Type |
|---|---|
Referee ID | number |
Reason for ReplacementRequired | choice |
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
| Field | Type |
|---|---|
Referee ID | number |
| Field | Type |
|---|---|
Replace button | boolean |
| Field | Type |
|---|---|
RoleRequired | text |
CandidateRequired | object |
First NameRequired | text |
Last NameRequired | text |
EmailRequired | |
Phone | text |
IP Address | text |
CriterionRequired | object |
IDRequired | choice |
Minimum RefereesRequired | number |
Note to Candidate | text |
Note to Referee | text |
Referees | array |
| Field | Type |
|---|---|
Candidate EmailRequired | |
Reference TypeRequired | choice |
First NameRequired | text |
Last NameRequired | text |
Referee EmailRequired | |
PhoneRequired | text |
Position RefereeRequired | text |
Position CandidateRequired | text |
Start DateRequired | date |
End DateRequired | date |
Company NameRequired | text |

