Requirements
To use Xref on WEXTL you need an active account and OAuth client credentials, granted by signing in with your account.[3]
Get your Xref credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Open API - API Keypassword
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).
[1]
Connect Xref in WEXTL
- Log in to your WEXTL account, add the Xref node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Xref account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Xref node modules
The list below is a reference of every Xref node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Xref node module below to inspect its input parameters, outputs, and connection requirements.
Watch ChecksTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Integration | text |
| Integration sub | text |
| Requested | date |
| Requester | object |
| ID | number |
| First name | text |
| Last name | text |
| text | |
| URL | text |
| Candidate | object |
| First name | text |
| Last name | text |
| text | |
| Xref | object |
| Role | text |
| State | text |
| State last updated | date |
| Criterion | object |
| Referees | array |
| URL | text |
Watch CriteriaTrigger
Output fields[3]
| 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 |
Watch EventsTrigger
Output fields[3]
| Field | Type |
|---|---|
| User ID | number |
| Email address | |
| Name | text |
| Date created | date |
Watch Hiring AccountsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | text |
Watch LogsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Created | date |
| Method | text |
| Endpoint | text |
| Status | number |
| Event | text |
| URL | text |
Watch QuestionnairesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Title | text |
| Questions | array |
| URL | text |
Watch Reference TypesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | text |
Watch UsersTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| First name | text |
| Last name | text |
| text | |
| Permissions | array |
| URL | text |
Get a CheckAction
Input fields[3]
| Field | Type |
|---|---|
| Check ID | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Integration | text |
| Integration sub | text |
| Requested | date |
| Requester | object |
| ID | number |
| First name | text |
| Last name | text |
| text | |
| URL | text |
| Candidate | object |
| First name | text |
| Last name | text |
| 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 |
Get a Check's LifecycleSearch
Get a CriterionAction
Get a LogAction
Get a PDF ReportAction
Input fields[3]
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
| Binary | choice |
Get a QuestionnaireAction
Get a Referee AttachmentAction
Input fields[3]
| Field | Type |
|---|---|
Check IDRequired | choice |
Attachment IDRequired | text |
| Binary | choice |
Get a ReportAction
Get a UserAction
Get an EmployerAction
Get CreditsAction
Output fields[3]
| Field | Type |
|---|---|
| Credits remaining | number |
List ChecksSearch
Input fields[3]
| Field | Type |
|---|---|
| States | choice |
| Search | text |
| Requester | choice |
| Date Start | date |
| Date End | date |
| Unread Only | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Integration | text |
| Integration sub | text |
| Requested | date |
| Requester | object |
| ID | number |
| First name | text |
| Last name | text |
| text | |
| URL | text |
| Candidate | object |
| First name | text |
| Last name | text |
| text | |
| Xref | object |
| Role | text |
| State | text |
| State last updated | date |
| Criterion | object |
| Referees | array |
| URL | text |
List Company DomainsAction
Output fields[3]
| Field | Type |
|---|---|
| Email domains | array |
List CriteriaSearch
List EmployersSearch
List Hiring AccountsSearch
List LogsSearch
List QuestionnairesSearch
List Referee AttachmentsSearch
List Reference TypesSearch
List UsersSearch
Retrieve a JSON ReportAction
Input fields[3]
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
Output fields[3]
| Field | Type |
|---|---|
| Candidate | object |
| ID | number |
| Name | text |
| Position | text |
| Verb | text |
| Modifications | array |
| text | |
| Phone number | text |
| Organisation | text |
| Answers | array |
| Referee | object |
| ID | number |
| Name | text |
| Position | text |
| Organisation | text |
| Date answered | text |
| text | |
| Phone number | text |
| Uploaded PDF URL | text |
| Uploaded PDF title | text |
| Candidate position | text |
Add an Unusual Activity NoteAction
Input fields[3]
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
CommentsRequired | text |
Add an Unusual Activity ResolutionAction
Input fields[3]
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
ResolutionRequired | choice |
Add Company DomainsAction
Create a CheckAction
Input fields[3]
| Field | Type |
|---|---|
| Role | text |
| Employer | object |
| choice | |
| Candidate | object |
| First Name | text |
| Last Name | text |
| 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 |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Requested | date |
| Requester | object |
| ID | number |
| First name | text |
| Last name | text |
| text | |
| URL | text |
| Candidate | object |
| First name | text |
| Last name | text |
| 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 |
Create a Check with RefereesAction
Input fields[3]
| Field | Type |
|---|---|
RoleRequired | text |
CandidateRequired | object |
| First Name | text |
| Last Name | text |
| Phone | text |
| IP Address | text |
| Employer | object |
| choice | |
| Criterion | object |
| ID | choice |
| Minimum Referees | number |
| Note to Candidate | text |
| Note to Referee | text |
| Referees | array |
| Custom ID | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Requested | date |
| Requester | object |
| ID | number |
| First name | text |
| Last name | text |
| text | |
| URL | text |
| Candidate | object |
| First name | text |
| Last name | text |
| 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 |
Create a CriterionAction
Input fields[3]
| 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 |
Output fields[3]
| 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 |
Create an EmployerAction
Deactivate a CriterionAction
Deactivate a QuestionnaireAction
Delete Company DomainsAction
Output fields[3]
| Field | Type |
|---|---|
| Detail | text |
Hide a CheckAction
Input fields[3]
| Field | Type |
|---|---|
| Check ID | choice |
Make an API Calluniversal
Register a CompanyAction
Send a Replacement Reference EmailAction
Input fields[3]
| Field | Type |
|---|---|
| Referee ID | number |
Reason for ReplacementRequired | choice |
Send a Report to the Line ManagerAction
Input fields[3]
| Field | Type |
|---|---|
Check IDRequired | choice |
Referee IDRequired | number |
Unlock a Xref StatusAction
Validate a Check with RefereesAction
Input fields[3]
| 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 |
Validate a RefereeAction
Input fields[3]
| 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 |
Templates
Look for Xref templates in the WEXTL template library.
Browse templates →Explore alternative apps
- 7Shifts[2]Restaurant employee scheduling, time tracking, and team management.
- BullhornRecruiting ATS and CRM for staffing agencies and talent teams.
- AchieversEmployee recognition and engagement platform for celebrations, rewards, and newsfeeds.
- AladtecWorkforce scheduling and timekeeping for public safety and healthcare teams.
- BeameryTalent lifecycle CRM for recruiting, talent pooling, campaigns, and workforce planning.
References
- WEXTL® Xref Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Xref.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:13