About this integration
Frontline workforce management — scheduling, compliance, and communications. Connect it to any workflow without writing code.
You can choose from 2 triggers, 21 search modules and 31 actions. The connection type is basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | Contact your representative if you need a new token or if your token has been revoked. |
Use it in workflow automation
Start with Watch Events, then add Activate a User.
The canvas below runs Watch Events into Activate a User — watch the video, then drop a node onto the canvas.
Select the Watch Organization Attributes trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Delete an Organization Attribute as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 33 ready-made modules for HR work — each run logs its inputs and outputs for debugging.
Sona workflow on the canvas: Watch Organization Attributes then Delete an Organization Attribute
Triggers, searches and actions
Explore the fields available for each Sona trigger, search, and action — 2 triggers, 21 searchs, and 31 actions.
Triggers
Whenever something changes in the app, one of 2 available triggers can start a run immediately.
- Watch Events
- Watch Organization Attributes
Searches
21 search modules let you query the app mid-run and feed the results to the next step.
- Get a Custom Form Entry
- Get a Job
- Get a Leave Request
- Get a Level
- Get an Absence
Actions
Use 31 action modules to write data back into the app from anywhere in a run.
- Activate a User
- Amend an Absence Period
- Archive a Training Course
- Assign a Shift
- Cancel a Shift
Explore the fields available for each Sona trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Event TypeRequired | choice |
| Field | Type |
|---|---|
ID | text |
Inserted at | date |
Label | text |
Slug | text |
Type | text |
Updated at | date |
Value | text |
Searches
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Custom form ID | text |
Data | array |
ID | text |
User ID | text |
| Field | Type |
|---|---|
Job IDRequired | choice |
| Field | Type |
|---|---|
Archived at | date |
ID | text |
Name | text |
Upload ID | text |
| Field | Type |
|---|---|
Annual Leave Request IDRequired | choice |
| Field | Type |
|---|---|
Actual duration | number |
Denomination | text |
Duration | number |
End date | date |
External ids | array |
ID | text |
Request type | text |
Start date | date |
State | text |
User ID | text |
| Field | Type |
|---|---|
Level IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
Absence Period ID or IndexRequired | choice |
Include Payroll Run Rows | boolean |
| Field | Type |
|---|---|
Absence subtype ID | text |
Absence type ID | text |
Days | array |
Documents | array |
Ends at | date |
ID | text |
Idx | text |
Is open ended | boolean |
Is paid | boolean |
Linked shifts | array |
Payroll type | text |
Starts at | date |
User ID | text |
| Field | Type |
|---|---|
Org Attribute IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Inserted at | date |
Label | text |
Slug | text |
Type | text |
Updated at | date |
Value | text |
| Field | Type |
|---|---|
Shift IDRequired | choice |
| Field | Type |
|---|---|
Agency | object |
ID | text |
Category | text |
Description | text |
Draft of shift | object |
ID | text |
Filling way | text |
Finish datetime | date |
ID | text |
Internal ID | text |
Is shift run | boolean |
Is travel gap | boolean |
Org unit | object |
ID | text |
People we support | array |
Rate of pay | object |
ID | text |
Shift breaks | array |
Shift type | object |
ID | text |
Name | text |
Start datetime | date |
User working shift | object |
ID | text |
| Field | Type |
|---|---|
Course IDRequired | choice |
| Field | Type |
|---|---|
Archived | boolean |
Description | text |
Frequency | text |
ID | text |
Idx | text |
Mandatory | boolean |
Name | text |
Provider | text |
Type | text |
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
Types of work | array |
Sex | text |
Pay group ids | array |
Contact email | |
Insurance number | text |
Home address | object |
Address line 1 | text |
Address line 2 | text |
City | text |
Country | text |
Postcode | text |
Base roles | array |
Read only org units | array |
Home tier org units | array |
Next of kin | array |
Organisation ID | text |
Work phone number | text |
Work email | |
Skills and attributes | array |
ID | text |
Exclude from payroll | boolean |
Identifies as | text |
Receives content for org units | array |
External ID | text |
Auth strategies | array |
| Field | Type |
|---|---|
Metric IDRequired | text |
Org Unit IDRequired | choice |
TypeRequired | text |
| Field | Type |
|---|---|
Timestamp | date |
| Field | Type |
|---|---|
Contact Email | |
Email | |
Employee Number | text |
External ID | text |
Insurance Number | text |
| Field | Type |
|---|---|
Employment periods | array |
Employment periods truncated | boolean |
Lookup | object |
By | text |
User | object |
First name | text |
ID | text |
Insurance number | text |
Last name | text |
State | text |
| Field | Type |
|---|---|
Absence Type ID | choice |
Include Payroll Run Rows | boolean |
Order By | text |
User ID | choice |
External User ID | choice |
Limit | number |
| Field | Type |
|---|---|
Absence subtype ID | text |
Absence type ID | text |
Days | array |
Documents | array |
Ends at | date |
ID | text |
Idx | text |
Is open ended | boolean |
Is paid | boolean |
Linked shifts | array |
Payroll type | text |
Starts at | date |
User ID | text |
| Field | Type |
|---|---|
External ID | choice |
Maximum End Date | date |
Minimum Start Date | date |
Source Type | text |
User ID | choice |
Limit | number |
| Field | Type |
|---|---|
Actual duration | number |
Denomination | text |
Duration | number |
End date | date |
External ids | array |
ID | text |
Request type | text |
Start date | date |
State | text |
User ID | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Custom form ID | text |
Data | array |
ID | text |
User ID | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Archived at | date |
ID | text |
Name | text |
Upload ID | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Name | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Inserted at | date |
Label | text |
Slug | text |
Type | text |
Updated at | date |
Value | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Country code | text |
Date | date |
Day of week | text |
ID | text |
Is substitute | boolean |
Name | text |
Regions | array |
| Field | Type |
|---|---|
Max Start DateTimeRequired | date |
Min Start DateTimeRequired | date |
User ID | choice |
Limit | number |
| Field | Type |
|---|---|
Agency | object |
ID | text |
Category | text |
Description | text |
Draft of shift | object |
ID | text |
Filling way | text |
Finish datetime | date |
ID | text |
Internal ID | text |
Is shift run | boolean |
Is travel gap | boolean |
Org unit | object |
ID | text |
People we support | array |
Shift breaks | array |
Shift type | object |
ID | text |
Name | text |
Start datetime | date |
User working shift | object |
ID | text |
| Field | Type |
|---|---|
Archived | choice |
Mandatory | choice |
Name | text |
Limit | number |
| Field | Type |
|---|---|
Archived | boolean |
Description | text |
Frequency | text |
ID | text |
Idx | text |
Mandatory | boolean |
Name | text |
Provider | text |
Type | text |
| Field | Type |
|---|---|
Contact Email | |
Email | |
Employee Number | text |
External ID | choice |
Insurance Number | choice |
Last Day of Employment | date |
Order | text |
Org Unit IDs | choice |
State | choice |
Type | choice |
Updated At | date |
Limit | number |
| Field | Type |
|---|---|
Types of work | array |
Sex | text |
Pay group ids | array |
Contact email | |
Insurance number | text |
Home address | object |
Address line 1 | text |
Address line 2 | text |
City | text |
Country | text |
Postcode | text |
Base roles | array |
Read only org units | array |
Home tier org units | array |
Next of kin | array |
Organisation ID | text |
Work phone number | text |
Work email | |
Skills and attributes | array |
ID | text |
Exclude from payroll | boolean |
Identifies as | text |
Receives content for org units | array |
External ID | text |
Auth strategies | array |
Actions
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
Types of work | array |
Sex | text |
Pay group ids | array |
Contact email | |
Insurance number | text |
Home address | object |
Address line 1 | text |
Address line 2 | text |
City | text |
Country | text |
Postcode | text |
Base roles | array |
Read only org units | array |
Home tier org units | array |
Next of kin | array |
Organisation ID | text |
Work phone number | text |
Work email | |
Skills and attributes | array |
ID | text |
Exclude from payroll | boolean |
Identifies as | text |
Receives content for org units | array |
External ID | text |
Auth strategies | array |
| Field | Type |
|---|---|
Absence Period ID or IndexRequired | choice |
Payrolled Shifts Options | object |
During Absence Period | object |
Outside Absence Period | object |
Create Replacement Shifts | boolean |
Ends At | date |
Is Open Ended | boolean |
Starts At | date |
| Field | Type |
|---|---|
Absence | object |
Absence subtype ID | text |
Absence type ID | text |
Ends at | date |
ID | text |
Is open ended | boolean |
Starts at | date |
Shifts | object |
Cancelled | array |
Updated | array |
| Field | Type |
|---|---|
Course IDRequired | choice |
| Field | Type |
|---|---|
Archived | boolean |
Description | text |
Frequency | text |
ID | text |
Idx | text |
Mandatory | boolean |
Name | text |
Provider | text |
Type | text |
| Field | Type |
|---|---|
Shift IDRequired | choice |
Agency IDRequired | choice |
Agency Worker ID | choice |
Agency Worker First Name | text |
Agency Worker Last Name | text |
| Field | Type |
|---|---|
Agency | object |
ID | text |
Category | text |
Description | text |
Draft of shift | object |
ID | text |
Filling way | text |
Finish datetime | date |
ID | text |
Internal ID | text |
Is shift run | boolean |
Is travel gap | boolean |
Org unit | object |
ID | text |
People we support | array |
Rate of pay | object |
ID | text |
Shift breaks | array |
Shift type | object |
ID | text |
Name | text |
Start datetime | date |
User working shift | object |
ID | text |
| Field | Type |
|---|---|
Shift IDRequired | choice |
Agency IDRequired | choice |
Agency Worker ID | choice |
Agency Worker First Name | text |
Agency Worker Last Name | text |
| Field | Type |
|---|---|
Agency | object |
ID | text |
Category | text |
Description | text |
Draft of shift | object |
ID | text |
Filling way | text |
Finish datetime | date |
ID | text |
Internal ID | text |
Is shift run | boolean |
Is travel gap | boolean |
Org unit | object |
ID | text |
People we support | array |
Rate of pay | object |
ID | text |
Shift breaks | array |
Shift type | object |
ID | text |
Name | text |
Start datetime | date |
User working shift | object |
ID | text |
| Field | Type |
|---|---|
Custom Form IDRequired | choice |
User IDRequired | choice |
Employee Document Type | text |
Dynamic Fields | object |
Field Name | text |
Base64 | text |
Content Type | text |
Filename | text |
| Field | Type |
|---|---|
Custom form ID | text |
Data | array |
ID | text |
User ID | text |
| Field | Type |
|---|---|
Absence Type IDRequired | choice |
Ends AtRequired | date |
Starts AtRequired | date |
User IDRequired | choice |
Create Replacement Shifts | boolean |
IDX | text |
Is Open Ended | boolean |
| Field | Type |
|---|---|
Absence subtype ID | text |
Absence type ID | text |
Days | array |
Documents | array |
Ends at | date |
ID | text |
Idx | text |
Is open ended | boolean |
Is paid | boolean |
Linked shifts | array |
Payroll type | text |
Starts at | date |
User ID | text |
| Field | Type |
|---|---|
TypeRequired | choice |
Display NameRequired | text |
Description | text |
Inner Type for Weekday Attributes | text |
Snake_case Identifier | text |
Default Value | text |
| Field | Type |
|---|---|
ID | text |
Inserted at | date |
Label | text |
Slug | text |
Type | text |
Updated at | date |
Value | text |
| Field | Type |
|---|---|
CategoryRequired | choice |
Finish DateTimeRequired | date |
Org UnitRequired | object |
IDRequired | choice |
Shift TypeRequired | object |
IDRequired | choice |
Start DateTimeRequired | date |
Description | text |
Internal ID | text |
User Working Shift | object |
ID | choice |
| Field | Type |
|---|---|
Agency | object |
ID | text |
Category | text |
Description | text |
Draft of shift | object |
ID | text |
Filling way | text |
Finish datetime | date |
ID | text |
Internal ID | text |
Is shift run | boolean |
Is travel gap | boolean |
Org unit | object |
ID | text |
People we support | array |
Rate of pay | object |
ID | text |
Shift breaks | array |
Shift type | object |
ID | text |
Name | text |
Start datetime | date |
User working shift | object |
ID | text |
| Field | Type |
|---|---|
NameRequired | text |
MandatoryRequired | boolean |
Description | text |
Frequency | choice |
IDX | text |
Provider | text |
Type | choice |
| Field | Type |
|---|---|
Archived | boolean |
Description | text |
Frequency | text |
ID | text |
Idx | text |
Mandatory | boolean |
Name | text |
Provider | text |
Type | text |
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
Bank Account | object |
Account NameRequired | text |
Account NumberRequired | text |
Country CodeRequired | choice |
Sort CodeRequired | text |
Bank Name | text |
Manager Org Units | array |
Types of Work | array |
Authentication Strategies | array |
Receives Content for Org Units | array |
Home Address | object |
Address Line 1 | text |
Address Line 2 | text |
Address Line 3 | text |
Address Line 4 | text |
City | text |
Country | text |
Postcode | text |
Base Roles | array |
Next of Kin | array |
Contact Email | |
Work Phone Number | text |
Work Email | |
Create Employment Period | boolean |
Exclude from Payroll | boolean |
Identifies As | choice |
Administrative Org Unit | object |
IDRequired | choice |
External ID | text |
Marital Status | choice |
External ID | text |
Insurance Number | text |
| Field | Type |
|---|---|
Types of work | array |
Sex | text |
Pay group ids | array |
Contact email | |
Insurance number | text |
Home address | object |
Address line 1 | text |
Address line 2 | text |
City | text |
Country | text |
Postcode | text |
Base roles | array |
Read only org units | array |
Home tier org units | array |
Next of kin | array |
Organisation ID | text |
Work phone number | text |
Work email | |
Skills and attributes | array |
ID | text |
Exclude from payroll | boolean |
Identifies as | text |
Receives content for org units | array |
External ID | text |
Auth strategies | array |
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
Types of work | array |
Sex | text |
Pay group ids | array |
Contact email | |
Insurance number | text |
Home address | object |
Address line 1 | text |
Address line 2 | text |
City | text |
Country | text |
Postcode | text |
Base roles | array |
Read only org units | array |
Home tier org units | array |
Next of kin | array |
Organisation ID | text |
Work phone number | text |
Work email | |
Skills and attributes | array |
ID | text |
Exclude from payroll | boolean |
Identifies as | text |
Receives content for org units | array |
External ID | text |
Auth strategies | array |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Absence Period ID or IndexRequired | choice |
Delete Associated Shifts | boolean |
| Field | Type |
|---|---|
ID | text |
Idx | text |
| Field | Type |
|---|---|
Org Attribute IDRequired | 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 |
|---|---|
Metric IDRequired | text |
Current Timestamp | date |
Actual | object |
Organization Unit ID 1 | array |
System Forecasted | object |
Organization Unit ID 2 | array |
| Field | Type |
|---|---|
Total inserted | number |
| Field | Type |
|---|---|
Metric IDRequired | text |
Actual | object |
Org Unit ID | object |
System Forecasted | object |
Org Unit ID | object |
| Field | Type |
|---|---|
Total inserted | number |
| Field | Type |
|---|---|
Metric IDRequired | text |
Current Timestamp | date |
Org Unit IDRequired | choice |
TypeRequired | text |
Metrics | array |
| Field | Type |
|---|---|
Items | array |
| Field | Type |
|---|---|
Metric IDRequired | text |
Org Unit IDRequired | choice |
TypeRequired | text |
Metrics | array |
| Field | Type |
|---|---|
Items | array |
| Field | Type |
|---|---|
User IDRequired | choice |
Final Date of EmploymentRequired | date |
Termination Reason Details | text |
Termination Reason ID | text |
Termination Would Rehire | boolean |
| Field | Type |
|---|---|
Active | boolean |
External ID | text |
Final date of employment | date |
First name | text |
ID | text |
Last employment period ID | text |
Last name | text |
Middle name | text |
State | text |
Termination reason details | text |
Termination reason ID | text |
Termination would rehire | boolean |
| Field | Type |
|---|---|
Course IDRequired | choice |
| Field | Type |
|---|---|
Archived | boolean |
Description | text |
Frequency | text |
ID | text |
Idx | text |
Mandatory | boolean |
Name | text |
Provider | text |
Type | text |
| Field | Type |
|---|---|
Shift IDRequired | choice |
Agency IDRequired | choice |
Agency Worker ID | choice |
Agency Worker First Name | text |
Agency Worker Last Name | text |
| Field | Type |
|---|---|
Agency | object |
ID | text |
Category | text |
Description | text |
Draft of shift | object |
ID | text |
Filling way | text |
Finish datetime | date |
ID | text |
Internal ID | text |
Is shift run | boolean |
Is travel gap | boolean |
Org unit | object |
ID | text |
People we support | array |
Rate of pay | object |
ID | text |
Shift breaks | array |
Shift type | object |
ID | text |
Name | text |
Start datetime | date |
User working shift | object |
ID | text |
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
Types of work | array |
Sex | text |
Pay group ids | array |
Contact email | |
Insurance number | text |
Home address | object |
Address line 1 | text |
Address line 2 | text |
City | text |
Country | text |
Postcode | text |
Base roles | array |
Read only org units | array |
Home tier org units | array |
Next of kin | array |
Organisation ID | text |
Work phone number | text |
Work email | |
Skills and attributes | array |
ID | text |
Exclude from payroll | boolean |
Identifies as | text |
Receives content for org units | array |
External ID | text |
Auth strategies | array |
| Field | Type |
|---|---|
IDRequired | choice |
Custom Fields to Upate | array |
| Field | Type |
|---|---|
Custom form ID | text |
Data | array |
ID | text |
User ID | text |
| Field | Type |
|---|---|
Absence Period ID or IndexRequired | choice |
Starts At | date |
Ends At | date |
Create Replacement Shifts | boolean |
Is Open Ended | boolean |
| Field | Type |
|---|---|
Absence subtype ID | text |
Absence type ID | text |
Days | array |
Documents | array |
Ends at | date |
ID | text |
Idx | text |
Is open ended | boolean |
Is paid | boolean |
Linked shifts | array |
Payroll type | text |
Starts at | date |
User ID | text |
| Field | Type |
|---|---|
Org Attribute IDRequired | choice |
Description | text |
Inner Type | text |
Display Name | text |
TypeRequired | choice |
Default Value | text |
| Field | Type |
|---|---|
ID | text |
Inserted at | date |
Label | text |
Slug | text |
Type | text |
Updated at | date |
Value | text |
| Field | Type |
|---|---|
Shift IDRequired | choice |
CategoryRequired | choice |
Finish DateTimeRequired | date |
Org UnitRequired | object |
IDRequired | choice |
Shift TypeRequired | object |
IDRequired | choice |
Start DateTimeRequired | date |
Description | text |
Internal ID | text |
User Working Shift | object |
ID | choice |
| Field | Type |
|---|---|
Agency | object |
ID | text |
Category | text |
Description | text |
Draft of shift | object |
ID | text |
Filling way | text |
Finish datetime | date |
ID | text |
Internal ID | text |
Is shift run | boolean |
Is travel gap | boolean |
Org unit | object |
ID | text |
People we support | array |
Rate of pay | object |
ID | text |
Shift breaks | array |
Shift type | object |
ID | text |
Name | text |
Start datetime | date |
User working shift | object |
ID | text |
| Field | Type |
|---|---|
Course IDRequired | choice |
Description | text |
Frequency | choice |
Mandatory | boolean |
Name | text |
Provider | text |
Type | choice |
| Field | Type |
|---|---|
Archived | boolean |
Description | text |
Frequency | text |
ID | text |
Idx | text |
Mandatory | boolean |
Name | text |
Provider | text |
Type | text |
| Field | Type |
|---|---|
User IDRequired | choice |
First NameRequired | text |
Last NameRequired | text |
Bank Account | object |
Account NameRequired | text |
Account NumberRequired | text |
Country CodeRequired | choice |
Sort CodeRequired | text |
Bank Name | text |
Manager Org Units | array |
Types of Work | array |
Authentication Strategies | array |
Receives Content for Org Units | array |
Home Address | object |
Address Line 1 | text |
Address Line 2 | text |
Address Line 3 | text |
Address Line 4 | text |
City | text |
Country | text |
Postcode | text |
Base Roles | array |
Next of Kin | array |
Contact Email | |
Work Phone Number | text |
Work Email | |
Create Employment Period | boolean |
Exclude from Payroll | boolean |
Identifies As | choice |
Administrative Org Unit | object |
IDRequired | choice |
External ID | text |
Marital Status | choice |
External ID | text |
| Field | Type |
|---|---|
Types of work | array |
Sex | text |
Pay group ids | array |
Contact email | |
Insurance number | text |
Home address | object |
Address line 1 | text |
Address line 2 | text |
City | text |
Country | text |
Postcode | text |
Base roles | array |
Read only org units | array |
Home tier org units | array |
Next of kin | array |
Organisation ID | text |
Work phone number | text |
Work email | |
Skills and attributes | array |
ID | text |
Exclude from payroll | boolean |
Identifies as | text |
Receives content for org units | array |
External ID | text |
Auth strategies | array |
| Field | Type |
|---|---|
File TypeRequired | choice |
CSV FileRequired | text |
File Name | text |
| Field | Type |
|---|---|
Message | text |

