Sona - Apps Documentation

Requirements

Connecting Sona takes an active account plus an API access token from your account settings — no other setup is required.[3]

Get your Sona credentials

API KeypasswordRequired
Contact your representative if you need a new token or if your token has been revoked.
[1]

Connect Sona in WEXTL

Log in to your WEXTL account, add the Sona 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 Sona 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 →

Sona node modules

The list below is a reference of every Sona node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Expand any Sona node module below to see exactly what it takes in, what it returns, and what connection it needs.

Watch EventsTrigger

Output fields[3]

Field	Type
Event TypeRequired	choice

Watch Organization AttributesTrigger

Output fields[3]

Field	Type
ID	text
Inserted at	date
Label	text
Slug	text
Type	text
Updated at	date
Value	text

Get a Custom Form EntryAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
Custom form ID	text
Data	array
ID	text
User ID	text

Get a JobAction

Input fields[3]

Field	Type
Job IDRequired	choice

Output fields[3]

Field	Type
Archived at	date
ID	text
Name	text
Upload ID	text

Get a Leave RequestAction

Input fields[3]

Field	Type
Annual Leave Request IDRequired	choice

Output fields[3]

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

Get a LevelAction

Input fields[3]

Field	Type
Level IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text

Get a ShiftAction

Input fields[3]

Field	Type
Shift IDRequired	choice

Output fields[3]

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

Get a Training CourseAction

Input fields[3]

Field	Type
Course IDRequired	choice

Output fields[3]

Field	Type
Archived	boolean
Description	text
Frequency	text
ID	text
Idx	text
Mandatory	boolean
Name	text
Provider	text
Type	text

Get a UserAction

Input fields[3]

Field	Type
User IDRequired	choice

Output fields[3]

Field	Type
Types of work	array
Sex	text
Pay group ids	array
Contact email	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	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

19other output fields

Get an AbsenceAction

Input fields[3]

Field	Type
Absence Period ID or IndexRequired	choice
Include Payroll Run Rows	boolean

Output fields[3]

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

Get an Organization AttributeAction

Input fields[3]

Field	Type
Org Attribute IDRequired	choice

Output fields[3]

Field	Type
ID	text
Inserted at	date
Label	text
Slug	text
Type	text
Updated at	date
Value	text

Get Latest Metric TimestampAction

Input fields[3]

Field	Type
Metric IDRequired	text
Org Unit IDRequired	choice
TypeRequired	text

Output fields[3]

Field	Type
Timestamp	date

Get User LookupAction

Input fields[3]

Field	Type
Contact Email	email
Email	email
Employee Number	text
External ID	text
Insurance Number	text

Output fields[3]

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

List AbsencesSearch

Input fields[3]

Field	Type
Absence Type ID	choice
Include Payroll Run Rows	boolean
Order By	text
User ID	choice
External User ID	choice
Limit	number

Output fields[3]

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

List Annual Leave RequestsSearch

Input fields[3]

Field	Type
External ID	choice
Maximum End Date	date
Minimum Start Date	date
Source Type	text
User ID	choice
Limit	number

Output fields[3]

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

List Custom Form EntriesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Custom form ID	text
Data	array
ID	text
User ID	text

List JobsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Archived at	date
ID	text
Name	text
Upload ID	text

List LevelsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text

List Organization AttributesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Inserted at	date
Label	text
Slug	text
Type	text
Updated at	date
Value	text

List Public HolidaysSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Country code	text
Date	date
Day of week	text
ID	text
Is substitute	boolean
Name	text
Regions	array

List ShiftsSearch

Input fields[3]

Field	Type
Max Start DateTimeRequired	date
Min Start DateTimeRequired	date
User ID	choice
Limit	number

Output fields[3]

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

List Training CoursesSearch

Input fields[3]

Field	Type
Archived	choice
Mandatory	choice
Name	text
Limit	number

Output fields[3]

Field	Type
Archived	boolean
Description	text
Frequency	text
ID	text
Idx	text
Mandatory	boolean
Name	text
Provider	text
Type	text

List UsersSearch

Input fields[3]

Field	Type
Contact Email	email
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

Output fields[3]

Field	Type
Types of work	array
Sex	text
Pay group ids	array
Contact email	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	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

19other output fields

Activate a UserAction

Input fields[3]

Field	Type
User IDRequired	choice

Output fields[3]

Field	Type
Types of work	array
Sex	text
Pay group ids	array
Contact email	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	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

19other output fields

Amend an Absence PeriodAction

Input fields[3]

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

Output fields[3]

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

Archive a Training CourseAction

Input fields[3]

Field	Type
Course IDRequired	choice

Output fields[3]

Field	Type
Archived	boolean
Description	text
Frequency	text
ID	text
Idx	text
Mandatory	boolean
Name	text
Provider	text
Type	text

Assign a ShiftAction

Input fields[3]

Field	Type
Shift IDRequired	choice
Agency IDRequired	choice
Agency Worker ID	choice
Agency Worker First Name	text
Agency Worker Last Name	text

Output fields[3]

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

Cancel a ShiftAction

Input fields[3]

Field	Type
Shift IDRequired	choice
Agency IDRequired	choice
Agency Worker ID	choice
Agency Worker First Name	text
Agency Worker Last Name	text

Output fields[3]

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

Create a Custom Form EntryAction

Input fields[3]

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

Output fields[3]

Field	Type
Custom form ID	text
Data	array
ID	text
User ID	text

Create a ShiftAction

Input fields[3]

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

Output fields[3]

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

Create a Training CourseAction

Input fields[3]

Field	Type
NameRequired	text
MandatoryRequired	boolean
Description	text
Frequency	choice
IDX	text
Provider	text
Type	choice

Output fields[3]

Field	Type
Archived	boolean
Description	text
Frequency	text
ID	text
Idx	text
Mandatory	boolean
Name	text
Provider	text
Type	text

Create a UserAction

Input fields[3]

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	email
Work Phone Number	text
Work Email	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

7other input fields

Output fields[3]

Field	Type
Types of work	array
Sex	text
Pay group ids	array
Contact email	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	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

19other output fields

Create an AbsenceAction

Input fields[3]

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

Output fields[3]

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

Create an Organization AttributeAction

Input fields[3]

Field	Type
TypeRequired	choice
Display NameRequired	text
Description	text
Inner Type for Weekday Attributes	text
Snake_case Identifier	text
Default Value	text

Output fields[3]

Field	Type
ID	text
Inserted at	date
Label	text
Slug	text
Type	text
Updated at	date
Value	text

Deactivate a UserAction

Input fields[3]

Field	Type
User IDRequired	choice

Output fields[3]

Field	Type
Types of work	array
Sex	text
Pay group ids	array
Contact email	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	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

19other output fields

Delete a Custom Form EntryAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an AbsenceAction

Input fields[3]

Field	Type
Absence Period ID or IndexRequired	choice
Delete Associated Shifts	boolean

Output fields[3]

Field	Type
ID	text
Idx	text

Delete an Organization AttributeAction

Input fields[3]

Field	Type
Org Attribute IDRequired	choice

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Store Multiple Historical Metric ValuesAction

Input fields[3]

Field	Type
Metric IDRequired	text
Current Timestamp	date
Actual	object
Organization Unit ID 1	array
System Forecasted	object
Organization Unit ID 2	array

Output fields[3]

Field	Type
Total inserted	number

Store Multiple Metric ValuesAction

Input fields[3]

Field	Type
Metric IDRequired	text
Actual	object
Org Unit ID	object
System Forecasted	object
Org Unit ID	object

Output fields[3]

Field	Type
Total inserted	number

Store Single Historical Metric ValueAction

Input fields[3]

Field	Type
Metric IDRequired	text
Current Timestamp	date
Org Unit IDRequired	choice
TypeRequired	text
Metrics	array

Output fields[3]

Field	Type
Items	array

Store Single Metric ValueAction

Input fields[3]

Field	Type
Metric IDRequired	text
Org Unit IDRequired	choice
TypeRequired	text
Metrics	array

Output fields[3]

Field	Type
Items	array

Terminate a UserAction

Input fields[3]

Field	Type
User IDRequired	choice
Final Date of EmploymentRequired	date
Termination Reason Details	text
Termination Reason ID	text
Termination Would Rehire	boolean

Output fields[3]

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

Unarchive a Training CourseAction

Input fields[3]

Field	Type
Course IDRequired	choice

Output fields[3]

Field	Type
Archived	boolean
Description	text
Frequency	text
ID	text
Idx	text
Mandatory	boolean
Name	text
Provider	text
Type	text

Unassign a ShiftAction

Input fields[3]

Field	Type
Shift IDRequired	choice
Agency IDRequired	choice
Agency Worker ID	choice
Agency Worker First Name	text
Agency Worker Last Name	text

Output fields[3]

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

Undo Terminate a UserAction

Input fields[3]

Field	Type
User IDRequired	choice

Output fields[3]

Field	Type
Types of work	array
Sex	text
Pay group ids	array
Contact email	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	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

19other output fields

Update a Custom Form EntryAction

Input fields[3]

Field	Type
IDRequired	choice
Custom Fields to Upate	array

Output fields[3]

Field	Type
Custom form ID	text
Data	array
ID	text
User ID	text

Update a ShiftAction

Input fields[3]

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

Output fields[3]

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

Update a Training CourseAction

Input fields[3]

Field	Type
Course IDRequired	choice
Description	text
Frequency	choice
Mandatory	boolean
Name	text
Provider	text
Type	choice

Output fields[3]

Field	Type
Archived	boolean
Description	text
Frequency	text
ID	text
Idx	text
Mandatory	boolean
Name	text
Provider	text
Type	text

Update a UserAction

Input fields[3]

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	email
Work Phone Number	text
Work Email	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

8other input fields

Output fields[3]

Field	Type
Types of work	array
Sex	text
Pay group ids	array
Contact email	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	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

19other output fields

Update an AbsenceAction

Input fields[3]

Field	Type
Absence Period ID or IndexRequired	choice
Starts At	date
Ends At	date
Create Replacement Shifts	boolean
Is Open Ended	boolean

Output fields[3]

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

Update an Organization AttributeAction

Input fields[3]

Field	Type
Org Attribute IDRequired	choice
Description	text
Inner Type	text
Display Name	text
TypeRequired	choice
Default Value	text

Output fields[3]

Field	Type
ID	text
Inserted at	date
Label	text
Slug	text
Type	text
Updated at	date
Value	text

Upload a CSV FileAction

Input fields[3]

Field	Type
File TypeRequired	choice
CSV FileRequired	text
File Name	text

Output fields[3]

Field	Type
Message	text

Templates

Look for Sona templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in HR category →

References

WEXTL® Sona Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Sona.
WEXTL® visual workflow builder data.

Last updated: Jul 18, 2026 19:12

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.