Rosterfy - Apps Documentation

Requirements

To use Rosterfy on WEXTL you need an active account and OAuth client credentials, granted by signing in with your account.[3]

Get your Rosterfy credentials

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

SubdomaintextRequired
Your account subdomain. For example, if your URL is https://acme.rosterfy.com, enter 'acme'.
[1]
Client IDtextRequired
The Client ID from your Personal Access Client.
[1]
Client SecretpasswordRequired
The Client Secret from your Personal Access Client.
[1]

Connect Rosterfy in WEXTL

Log in to your WEXTL account, add the Rosterfy node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Rosterfy 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 →

Rosterfy node modules

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

Open any Rosterfy node module below to inspect its input parameters, outputs, and connection requirements.

Watch New AccountsTrigger

Output fields[3]

Field	Type
ID	number
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Watch New Blog ArticlesTrigger

Output fields[3]

Field	Type
Object	object
ID	number
Name	text
Sub heading	text
Description	text
Content	text
Blog article type ID	text
Author ID	number
Thumbnail	text
Banner image	text
Token	text
Nice	object
Description	text
Relations	array
Permissions	object
Read	boolean
Update	boolean
Delete	boolean

Watch New EventsTrigger

Output fields[3]

Field	Type
ID	number
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Watch New FormsTrigger

Output fields[3]

Field	Type
Object	object
ID	number
Form type ID	number
Name	text
Form title	text
Public	text
Is archived	number
Created at	text
Updated at	text
Nice	object
Rrn	text
Is open	text
Relations	object
Form type	object
Permissions	object
Read	boolean
Update	boolean
Delete	boolean
Copy	boolean

Watch New Inventory ItemsTrigger

Output fields[3]

Field	Type
ID	number
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Watch New ReportsTrigger

Output fields[3]

Field	Type
Object	object
ID	number
Report type ID	number
Report category ID	text
User ID	number
Name	text
Filters	array
Columns	array
Sorting	array
Grouping	array
With media	number
Nice	object
Rrn	text
Status	text
Columns preview	text
Relations	object
Report type	object
Report category	object
User	object

Watch New Training ModulesTrigger

Output fields[3]

Field	Type
ID	number
Object	object
ID	number
Name	text
Permissions	object
Update	boolean
Delete	boolean

Watch New UsersTrigger

Output fields[3]

Field	Type
Object	object
ID	number
User checkpoint ID	number
Email	text
First name	text
Middle name	text
Last name	text
Preferred name	text
Phone	text
Dob	text
Picture	text
Nice	object
Phone	text
Phone:raw	text
User checkpoint ID	number
Name	text
Info	text
Preferred first name	text
Relations	object
Permissions	object
Update	boolean
Delete	boolean
Impersonate	boolean
Attributes	array

Get AccountAction

Input fields[3]

Field	Type
Account IDRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Get Blog ArticleAction

Input fields[3]

Field	Type
Article IDRequired	choice

Output fields[3]

Field	Type
Object	object
Name	text
Content	text
Sub heading	text
Publish	boolean
Public	boolean
Promoted	boolean
Banner image	text
Thumbnail	text
Description	text
Author ID	number
Nice	object
Description	text
Read at	text
Relations	array
Permissions	object
Read	boolean
Update	boolean
Delete	boolean

Get EventAction

Input fields[3]

Field	Type
Event IDRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Get Event Reward FormAction

Input fields[3]

Field	Type
EventRequired	choice

Get Form Submission ColumnsAction

Input fields[3]

Field	Type
FormRequired	choice

Output fields[3]

Field	Type
Value	text
Text	text

Get Form ViewAction

Input fields[3]

Field	Type
FormRequired	choice
Locale	text

Output fields[3]

Field	Type
Object	object
ID	number
Form type ID	number
Name	text
Form title	text
Form category ID	number
Success content	text
Close content	text
Options	object
Rules	array
Cost	text
Nice	object
Rrn	text
Is open	text
Close at	text
Is foreign account	boolean
Relations	object
Form type	object
Fields	array
Permissions	object
Read	boolean
Update	boolean
Delete	boolean
Copy	boolean

Get Inventory AllocationAction

Input fields[3]

Field	Type
Inventory Allocation IDRequired	number

Get Inventory Allocation FormAction

Input fields[3]

Field	Type
Inventory Allocation IDRequired	number

Get Inventory Allocation ItemAction

Input fields[3]

Field	Type
Inventory Allocation IDRequired	number
Allocation Item IDRequired	number

Get Inventory ItemAction

Input fields[3]

Field	Type
Inventory Item IDRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Get ReportAction

Input fields[3]

Field	Type
Report IDRequired	number

Get ShiftAction

Input fields[3]

Field	Type
EventRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Get Shift LinkAction

Input fields[3]

Field	Type
EventRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Get Shift Reward FormAction

Input fields[3]

Field	Type
EventRequired	choice
Shift IDRequired	number

Get Training ModuleAction

Input fields[3]

Field	Type
Training Module IDRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Get UserAction

Input fields[3]

Field	Type
User IDRequired	choice
Include Relations	text

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Get User Reward PointsAction

Input fields[3]

Field	Type
User IDRequired	choice

Get User Submission ColumnsAction

Input fields[3]

Field	Type
UserRequired	choice

Output fields[3]

Field	Type
Value	text
Text	text

List AccountsSearch

Input fields[3]

Field	Type
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

List Blog ArticlesSearch

Input fields[3]

Field	Type
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
Name	text
Sub heading	text
Description	text
Content	text
Blog article type ID	text
Author ID	number
Thumbnail	text
Banner image	text
Token	text
Nice	object
Description	text
Relations	array
Permissions	object
Read	boolean
Update	boolean
Delete	boolean

List Event ShiftsSearch

Input fields[3]

Field	Type
EventRequired	choice
LimitRequired	number
Sort By	text
Sort Order	choice

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

List EventsSearch

Input fields[3]

Field	Type
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

List Form SubmissionsSearch

Input fields[3]

Field	Type
FormRequired	choice
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
Form ID	number
User ID	number
Entity	text
Entity ID	text
Requires resubmission	number
Created at	date
Updated at	date
Custom first name	text
Custom email	text
Nice	object
Rrn	text
Custom first name	text
Custom email	text
Relations	object
User	object
Permissions	object
Read	boolean
Update	boolean
Delete	boolean
Attributes	object
Custom first name	object
Custom email	object

List FormsSearch

Input fields[3]

Field	Type
LimitRequired	number
Sort By	text
Sort Order	choice

Output fields[3]

Field	Type
Object	object
ID	number
Form type ID	number
Name	text
Form title	text
Public	text
Is archived	number
Created at	text
Updated at	text
Nice	object
Rrn	text
Is open	text
Relations	object
Form type	object
Permissions	object
Read	boolean
Update	boolean
Delete	boolean
Copy	boolean

List Inventory ItemsSearch

Input fields[3]

Field	Type
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

List Linked ShiftsSearch

Input fields[3]

Field	Type
EventRequired	choice
Limit	number

Output fields[3]

Field	Type
Object	object
Nice	object
Relations	object
Permissions	object
Attributes	array

List ReportsSearch

Input fields[3]

Field	Type
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
Report type ID	number
Report category ID	text
User ID	number
Name	text
Filters	array
Columns	array
Sorting	array
Grouping	array
With media	number
Nice	object
Rrn	text
Status	text
Columns preview	text
Relations	object
Report type	object
Report category	object
User	object

List Training ModulesSearch

Input fields[3]

Field	Type
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
Name	text
Permissions	object
Update	boolean
Delete	boolean

List User SubmissionsSearch

Input fields[3]

Field	Type
UserRequired	choice
LimitRequired	number
Sort By	text
Sort Order	choice

Output fields[3]

Field	Type
Object	object
ID	number
Form ID	number
User ID	number
Entity	text
Created at	text
Nice	object
Rrn	text
Relations	object
Form	object
Permissions	object
Read	boolean
Update	boolean
Delete	boolean
Attributes	object

List UsersSearch

Input fields[3]

Field	Type
Sort By	text
Sort Order	choice
Limit	number

Output fields[3]

Field	Type
Object	object
ID	number
User checkpoint ID	number
Email	text
First name	text
Middle name	text
Last name	text
Preferred name	text
Phone	text
Dob	text
Picture	text
Nice	object
Phone	text
Phone:raw	text
User checkpoint ID	number
Name	text
Info	text
Preferred first name	text
Relations	object
Permissions	object
Update	boolean
Delete	boolean
Impersonate	boolean
Attributes	array

Add Item to AllocationAction

Input fields[3]

Field	Type
Inventory Allocation IDRequired	number
Inventory ItemRequired	choice
QuantityRequired	text
Valid Duration	number

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Apply All ShiftsAction

Input fields[3]

Field	Type
Event	choice
ShiftsRequired	array

Output fields[3]

Field	Type
User ID	number

Bulk Update AccountsAction

No fields documented.

Bulk Update ShiftsAction

Input fields[3]

Field	Type
EventRequired	choice

Bulk Update UsersAction

No fields documented.

Cancel ShiftAction

Input fields[3]

Field	Type
EventRequired	choice
Notify Users	boolean

Output fields[3]

Field	Type
Queue	text

Collect Inventory ItemsAction

Input fields[3]

Field	Type
UserRequired	choice
Inventory Item IDsRequired	array

Copy FormAction

Input fields[3]

Field	Type
FormRequired	choice

Create AccountAction

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Create Blog ArticleAction

Input fields[3]

Field	Type
TitleRequired	text
Sub HeadingRequired	text
Short DescriptionRequired	text
Content (HTML)Required	text
Article Type ID	number
Thumbnail URL	text
Banner Image URL	text
Public	boolean
Publish	boolean
Promoted	boolean

Output fields[3]

Field	Type
Object	object
Name	text
Content	text
Sub heading	text
Publish	boolean
Public	boolean
Promoted	boolean
Banner image	text
Thumbnail	text
Description	text
Author ID	number
Nice	object
Description	text
Read at	text
Relations	array
Permissions	object
Read	boolean
Update	boolean
Delete	boolean

Create EventAction

Input fields[3]

Field	Type
Event Type IDRequired	text
Event NameRequired	text
Description (HTML)Required	text
Start Timestamp (ISO 8601)Required	date
TimezoneRequired	text
Address	object
Street Address 1	text
Street Address 2	text
Street Address 3	text
City	text
Postcode	text
Region	text
Country	text
Latitude	text
Longitude	text
Is Virtual	boolean
Publish	boolean
Public	boolean
Shift Status DefaultRequired	number
Shift Confirmed Status DefaultRequired	number
Shift Rejected Status DefaultRequired	number
Shift Checked-In Status DefaultRequired	number
Expression of Interest Form ID	number

4other input fields

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Create FormAction

Input fields[3]

Field	Type
Admin LabelRequired	text
Form Type IDRequired	number
User-Facing Title	text
Success Message (HTML)	text
Closed Message (HTML)	text
Form Category ID	number
Public Access	boolean
Is Archived	boolean

Create Inventory AllocationAction

Input fields[3]

Field	Type
Allocation Name	text
TypeRequired	choice
Rules	array

Create Inventory ItemAction

Input fields[3]

Field	Type
NameRequired	text
IconRequired	text
Has QuantityRequired	boolean
Is DistributableRequired	boolean
PublishRequired	boolean
External ID	text
Quantity	number

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Create ReportAction

Input fields[3]

Field	Type
Report Type IDRequired	number
User IDRequired	number
Report NameRequired	text
Report Category ID	number
Filters	array
Columns	array
Sorting	array
Include Media Files	boolean
Include Subaccounts	boolean
Is Scheduled	boolean
Timezone	text
Repeat Frequency (daily/weekly)	text

Create ShiftAction

Input fields[3]

Field	Type
EventRequired	choice
Shift NameRequired	text
Start Timestamp (ISO 8601)Required	date
End Timestamp (ISO 8601)	date
TimezoneRequired	time
Address	object
Street Address 1	text
Street Address 2	text
Street Address 3	text
City	text
Postcode	text
Region	text
Country	text
Latitude	text
Longitude	text
Shift Status DefaultRequired	number
Confirmed Status DefaultRequired	number
Rejected Status DefaultRequired	number
Checked-In Status DefaultRequired	number
Min Demand (users required)Required	number
Max Demand (users required)Required	number
Leader DemandRequired	number
Is Virtual (0/1)	number

4other input fields

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Create Training ModuleAction

Input fields[3]

Field	Type
NameRequired	text
Success Message	text
Is Archived	boolean
Estimated Complete Time (mins)	number
Publish	boolean
External ID	text
External Service Name	text

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Create UserAction

Input fields[3]

Field	Type
EmailRequired	email
First NameRequired	text
Middle Name	text
Last NameRequired	text
Date of Birth (YYYY-MM-DD)Required	date
Phone (e.g. AU-298606375)Required	text
Address	object
Street Address 1	text
Street Address 2	text
Street Address 3	text
City	text
Postcode	text
Region	text
Country	text
Latitude	text
Longitude	text
Agrees to TermsRequired	boolean
Subscribe to Marketing	boolean
Account Role IDs	array

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Delete AccountAction

Input fields[3]

Field	Type
Account IDRequired	choice

Delete Blog ArticleAction

Input fields[3]

Field	Type
Article IDRequired	choice

Delete EventAction

Input fields[3]

Field	Type
Event IDRequired	choice

Delete FormAction

Input fields[3]

Field	Type
FormRequired	choice

Delete Inventory AllocationAction

Input fields[3]

Field	Type
Inventory Allocation IDRequired	number

Delete Inventory Allocation ItemAction

Input fields[3]

Field	Type
Inventory Allocation IDRequired	number
Allocation Item IDRequired	number

Delete Inventory ItemAction

Input fields[3]

Field	Type
Inventory Item IDRequired	choice

Delete ReportAction

Input fields[3]

Field	Type
Report IDRequired	number

Delete ShiftAction

Input fields[3]

Field	Type
EventRequired	choice

Delete Shift LinkAction

Input fields[3]

Field	Type
EventRequired	choice

Delete Training ModuleAction

Input fields[3]

Field	Type
Training Module IDRequired	number

Delete UserAction

Input fields[3]

Field	Type
User IDRequired	choice

Export Form ResponsesAction

Input fields[3]

Field	Type
FormRequired	choice
Export Format	choice
Columns to Include	array

Output fields[3]

Field	Type
Message	text
Job ID	text
Status	text
Progress	number

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

Mass Add Item to UsersAction

Input fields[3]

Field	Type
Apply ToRequired	text
Inventory ItemRequired	choice
Allocation TypeRequired	text
QuantityRequired	number
Expires At (yyyy-mm-ddThh:mm)	text
Collected At (yyyy-mm-ddThh:mm)	text
User IDsRequired	array

Process Form SubmissionAction

Input fields[3]

Field	Type
FormRequired	choice
Entity ID (if updating existing)	number

Update AccountAction

Input fields[3]

Field	Type
Account IDRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Update Blog ArticleAction

Input fields[3]

Field	Type
Article IDRequired	choice
TitleRequired	text
Sub HeadingRequired	text
Short DescriptionRequired	text
Content (HTML)Required	text
Public	boolean
Publish	boolean
Promoted	boolean

Output fields[3]

Field	Type
Object	object
Name	text
Content	text
Sub heading	text
Publish	boolean
Public	boolean
Promoted	boolean
Banner image	text
Thumbnail	text
Description	text
Author ID	number
Nice	object
Description	text
Read at	text
Relations	array
Permissions	object
Read	boolean
Update	boolean
Delete	boolean

Update EventAction

Input fields[3]

Field	Type
Event IDRequired	number
Event Type IDRequired	text
Event NameRequired	text
Description (HTML)Required	text
Start Timestamp (ISO 8601)Required	text
TimezoneRequired	time
Address	object
Street Address 1	text
Street Address 2	text
Street Address 3	text
City	text
Postcode	text
Region	text
Country	text
Latitude	text
Longitude	text
Is Virtual	boolean
Publish	boolean
Public	boolean
Shift Status DefaultRequired	number
Shift Confirmed Status DefaultRequired	number
Shift Rejected Status DefaultRequired	number
Shift Checked-In Status DefaultRequired	number

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Update FormAction

Input fields[3]

Field	Type
FormRequired	choice
Admin Label	text
User-Facing Title	text
Success Message (HTML)	text
Closed Message (HTML)	text
Public Access	boolean
Is Archived	boolean
Form Category ID	number
Auto-Close At	text
Submission Cost	number
Tax Percentage (0-100)	number

Output fields[3]

Field	Type
Object	object
ID	number
Name	text
Form title	text
Updated at	text
Nice	object
Rrn	text
Relations	object
Permissions	object
Read	boolean
Update	boolean
Delete	boolean
Copy	boolean

Update Inventory Allocation ItemAction

Input fields[3]

Field	Type
Inventory Allocation IDRequired	number
Allocation Item IDRequired	choice
Inventory ItemRequired	choice
QuantityRequired	text
Valid Duration	number

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Update Inventory ItemAction

Input fields[3]

Field	Type
Inventory Item IDRequired	choice
NameRequired	text
IconRequired	text
Has QuantityRequired	boolean
Is DistributableRequired	boolean
PublishRequired	boolean
External ID	text
Quantity	number

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Update ReportAction

Input fields[3]

Field	Type
Report IDRequired	number

Update ShiftAction

Input fields[3]

Field	Type
EventRequired	choice
Shift NameRequired	text
Start Timestamp (ISO 8601)Required	date
End Timestamp (ISO 8601)	date
TimezoneRequired	text
Address	object
Street Address 1	text
Street Address 2	text
Street Address 3	text
City	text
Postcode	text
Region	text
Country	text
Latitude	text
Longitude	text
Shift Status DefaultRequired	number
Confirmed Status DefaultRequired	number
Rejected Status DefaultRequired	number
Checked-In Status DefaultRequired	number
Min DemandRequired	number
Max DemandRequired	number
Leader DemandRequired	number

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Update Shift LinkAction

Input fields[3]

Field	Type
EventRequired	choice

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Update Training ModuleAction

Input fields[3]

Field	Type
Training Module IDRequired	choice
NameRequired	text
Success Message	text
Is Archived	boolean
Estimated Complete Time (mins)	number
Publish	boolean
External ID	text
External Service Name	text

Output fields[3]

Field	Type
Object	object
ID	number
Nice	object
Rrn	text
Permissions	object
Update	boolean
Delete	boolean

Update UserAction

Input fields[3]

Field	Type
User IDRequired	choice
Email	email
First Name	text
Middle Name	text
Last Name	text
Date of Birth (YYYY-MM-DD)	date
Phone	text
Address	object
Street Address 1	text
Street Address 2	text
Street Address 3	text
City	text
Postcode	text
Region	text
Country	text
Latitude	text
Longitude	text
Subscribe to Marketing	boolean

Output fields[3]

Field	Type
Object	object
ID	number
Permissions	object
Update	boolean
Delete	boolean

Update User SubmissionsAction

Input fields[3]

Field	Type
UserRequired	choice
Submission IDsRequired	array

Templates

Look for Rosterfy templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in HR category →

References

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

Last updated: Jul 21, 2026 15:23

How we write our apps documentation

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