Requirements
Before you set up the credential, make sure you have an active Staffbase account and an API access token from your account settings ready.[3]
Get your Staffbase credentials
- SubdomaintextRequired
Open Staffbase Studio in your browser, look at the URL in the address bar and copy the part before .staffbase.com.
[1] - API KeypasswordRequired
Create an API token in Staffbase Studio under Settings → API Access by naming it and selecting permissions, then copy the generated token from the API Tokens page to use for authentication.
[1]
Connect Staffbase in WEXTL
- Log in to your WEXTL account, add the Staffbase 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 Staffbase 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 →
Staffbase node modules
The list below is a reference of every Staffbase node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Staffbase node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch CollectionTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Accessor ids | array |
| Admin ids | array |
| Medium count | number |
| Created at | date |
| Updated at | date |
Watch Collection FilesTrigger
| Field | Type |
|---|---|
| ID | text |
| Created | date |
| Created by | object |
| ID | text |
| First name | text |
| Last name | text |
| Mime type | text |
| Type | text |
| Original | object |
| Size | number |
| Height | number |
| Width | number |
| URL | url |
| File name | text |
| File extension | text |
| Reference count | number |
| Playback URL | text |
| Duration | number |
| Thumbnail | object |
| URL | text |
| Width | number |
| Height | number |
Watch CommentsTrigger
| Field | Type |
|---|---|
| ID | text |
| Installation ID | text |
| Parent ID | text |
| Parent type | text |
| Author ID | text |
| Published | boolean |
| Text | text |
| Author | object |
| Entity type | text |
| First name | text |
| ID | text |
| Last name | text |
| Root ID | text |
| Links | object |
| Unpublish | object |
| Delete | object |
| Rights | array |
| Entity type | text |
| Updated | date |
| Created | date |
Watch CSV ImportsTrigger
| Field | Type |
|---|---|
| ID | text |
| Created at | date |
| File name | text |
| File size | number |
| Record count | number |
| State | text |
| Owner | object |
| Owner ID | text |
| Type | text |
Watch FilesTrigger
| Field | Type |
|---|---|
| ID | text |
| Created | text |
| Created by | object |
| ID | text |
| First name | text |
| Last name | text |
| Mime type | text |
| Type | text |
| Original | object |
| Size | number |
| Height | number |
| Width | number |
| URL | url |
| File name | text |
| File extension | text |
| Reference count | number |
| Playback URL | url |
| Duration | number |
| Thumbnail | object |
| URL | url |
| Width | number |
| Height | number |
Watch Group MembersTrigger
| Field | Type |
|---|---|
| ID | text |
| Config | object |
| Locale | text |
| Created at | date |
| Activated at | date |
| External ID | text |
| Role | text |
| object | |
| Value | text |
| Source | text |
| Status | text |
| Secret | text |
| Profile | object |
| Property 1 | text |
| Property 2 | text |
| User name | object |
| Value | text |
| Source | text |
Watch GroupsTrigger
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
Watch PagesTrigger
| Field | Type |
|---|---|
| ID | text |
| Created at | date |
| Updated at | date |
| Is outdated | boolean |
| Contents | object |
| En us | object |
| De de | object |
| Owner ID | text |
| Space ID | text |
| Readers | object |
| User ids | array |
| Admins | object |
| User ids | array |
| Group ids | array |
| Token ids | array |
Watch User GroupsTrigger
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
Watch UsersTrigger
| Field | Type |
|---|---|
| ID | text |
| Config | object |
| Locale | text |
| Created at | date |
| Activated at | date |
| External ID | text |
| Role | text |
| object | |
| Value | text |
| Source | text |
| Status | text |
| Secret | text |
| Profile | object |
| Property 1 | text |
| Property 2 | text |
| User name | object |
| Value | text |
| Source | text |
Get a CollectionAction
Get a GroupAction
| Field | Type |
|---|---|
Group IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
Get a PageAction
Get a UserAction
Get CSV Import ConfigurationAction
| Field | Type |
|---|---|
Import IDRequired | choice |
| Field | Type |
|---|---|
| Delta | boolean |
| Encoding | text |
| Generate recovery codes | boolean |
| Partial tag | text |
| Report mail address | text |
| Report only on errors | boolean |
| Send mails new | boolean |
| Send mails pending | boolean |
| Separator | text |
| Type | text |
| Mapping | object |
| External ID | text |
| Profile field:first name | text |
| Profile field:last name | text |
Get CSV Import MetadataAction
Get CSV Import StatusAction
List Collection FilesSearch
| Field | Type |
|---|---|
Collection IDRequired | choice |
| Sort By | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Created | date |
| Created by | object |
| ID | text |
| First name | text |
| Last name | text |
| Mime type | text |
| Type | text |
| Original | object |
| Size | number |
| Height | number |
| Width | number |
| URL | url |
| File name | text |
| File extension | text |
| Reference count | number |
| Playback URL | text |
| Duration | number |
| Thumbnail | object |
| URL | text |
| Width | number |
| Height | number |
List CollectionsSearch
List CommentsSearch
| Field | Type |
|---|---|
| Filter | text |
| Format | choice |
| Manage | boolean |
| Sort | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Installation ID | text |
| Parent ID | text |
| Parent type | text |
| Author ID | text |
| Published | boolean |
| Text | text |
| Author | object |
| Entity type | text |
| First name | text |
| ID | text |
| Last name | text |
| Root ID | text |
| Links | object |
| Unpublish | object |
| Delete | object |
| Rights | array |
| Entity type | text |
| Updated | date |
| Created | date |
List CSV ImportsSearch
List FilesSearch
| Field | Type |
|---|---|
Collection IDRequired | choice |
| Filters | array |
| Query | text |
| Sort By | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Created | text |
| Created by | object |
| ID | text |
| First name | text |
| Last name | text |
| Mime type | text |
| Type | text |
| Original | object |
| Size | number |
| Height | number |
| Width | number |
| URL | url |
| File name | text |
| File extension | text |
| Reference count | number |
| Playback URL | url |
| Duration | number |
| Thumbnail | object |
| URL | url |
| Width | number |
| Height | number |
List Group MembersSearch
| Field | Type |
|---|---|
Group IDRequired | choice |
QueryRequired | text |
| Status | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Config | object |
| Locale | text |
| Created at | date |
| Activated at | date |
| External ID | text |
| Role | text |
| object | |
| Value | text |
| Source | text |
| Status | text |
| Secret | text |
| Profile | object |
| Property 1 | text |
| Property 2 | text |
| User name | object |
| Value | text |
| Source | text |
List GroupsSearch
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
List PagesSearch
| Field | Type |
|---|---|
| Order By | choice |
| Status | choice |
Space IDsRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Created at | date |
| Updated at | date |
| Is outdated | boolean |
| Contents | object |
| En us | object |
| De de | object |
| Owner ID | text |
| Space ID | text |
| Readers | object |
| User ids | array |
| Admins | object |
| User ids | array |
| Group ids | array |
| Token ids | array |
List User GroupsSearch
| Field | Type |
|---|---|
User IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
List UsersSearch
List Users by TimestampSearch
| Field | Type |
|---|---|
| Include Deleted | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Activated | date |
| Avatar | object |
| Original | object |
| Icon | object |
| Thumb | object |
| Config | object |
| Locale | text |
| Created | date |
| Department | text |
| Emails | array |
| External ID | text |
| First name | text |
| Group i ds | array |
| ID | text |
| Last name | text |
| Location | text |
| Mandatory group i ds | array |
| Phone number | text |
| Position | text |
| Profile | text |
| Public email address | text |
| Role | object |
| Type | text |
| Status | text |
| Updated | date |
Search GroupsSearch
| Field | Type |
|---|---|
| Creator IDs | choice |
| Sort | choice |
| Query | text |
| Type | choice |
| Permission | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
Search PagesSearch
Search UsersSearch
Add a FileAction
| Field | Type |
|---|---|
Medium IDRequired | choice |
Add Files to a CollectionAction
Create a CollectionAction
Create a ConversationAction
| Field | Type |
|---|---|
Chat IDRequired | text |
Participant IDsRequired | choice |
MessageRequired | text |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Installation ID | text |
| Type | text |
| Creator ID | text |
| Admin i ds | array |
| Message count | number |
| Meta | object |
| Title | text |
| Image | object |
| Status | object |
| Oldest unread message ID | text |
| Muted | boolean |
| Archived | boolean |
Create a GroupAction
| Field | Type |
|---|---|
ConfigurationRequired | object |
LocalizationRequired | object |
| Show in Overview | boolean |
| Image URL | url |
| Icon | text |
| Custom Icon URL | url |
| Link | url |
| External ID | text |
| Accessor IDs | object |
| User IDs | choice |
| Group IDs | choice |
| Branch Access | boolean |
| Admin IDs | object |
| User IDs | choice |
| Group IDs | choice |
| Inclusions | array |
| Inclusion User IDs | choice |
| Exclusions | array |
| Exclusion User IDs | choice |
| Field | Type |
|---|---|
| Accessor ids | object |
| Branch access | boolean |
| ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Type | text |
| Updated at | date |
| Creator | object |
| ID | text |
| Type | text |
Create a PageAction
| Field | Type |
|---|---|
ContentsRequired | object |
| English (US) Content | object |
| Space ID | choice |
| Published | boolean |
| External ID | text |
| Reader IDs | choice |
| Admin IDs | choice |
| Field | Type |
|---|---|
| ID | text |
| Owner ID | text |
| Contents | object |
| En us | object |
| De de | object |
| Space ID | text |
| Branch ID | text |
| Created at | date |
| Updated at | date |
| Published at | date |
| Readers | object |
| User ids | array |
| Branch access | boolean |
| Admins | object |
| User ids | array |
| Group ids | array |
| Token ids | array |
Delete a CollectionAction
| Field | Type |
|---|---|
Collection IDRequired | choice |
Delete a ConversationAction
| Field | Type |
|---|---|
Conversation IDRequired | text |
Delete a CSV ImportAction
| Field | Type |
|---|---|
Import IDRequired | choice |
Delete a GroupAction
| Field | Type |
|---|---|
Group IDRequired | choice |
Delete a PageAction
| Field | Type |
|---|---|
Page IDRequired | choice |
Delete a UserAction
| Field | Type |
|---|---|
User IDRequired | choice |
Invite a UserAction
| Field | Type |
|---|---|
RoleRequired | text |
LocaleRequired | text |
| User Name | text |
| External ID | text |
| Profile | object |
| Property Name | text |
| Field | Type |
|---|---|
| ID | text |
| Config | object |
| Locale | text |
| Created at | date |
| Activated at | date |
| External ID | text |
| Role | text |
| object | |
| Value | text |
| Source | text |
| Status | text |
| Secret | text |
| Profile | object |
| Property 1 | text |
| Property 2 | text |
| User name | object |
| Value | text |
| Source | text |
Log Out a UserAction
| Field | Type |
|---|---|
User IDRequired | choice |
Make an API Calluniversal
Remove Files from a CollectionAction
| Field | Type |
|---|---|
Collection IDRequired | choice |
EntriesRequired | choice |
Send a Recovery EmailAction
| Field | Type |
|---|---|
User IDRequired | choice |
Stream Import Change LogsAction
| Field | Type |
|---|---|
Import IDRequired | choice |
Stream Import ErrorsAction
| Field | Type |
|---|---|
Import IDRequired | choice |
Update a CollectionAction
Update a GroupAction
| Field | Type |
|---|---|
Group IDRequired | choice |
| Configuration | object |
| Localization | object |
| Show in Overview | boolean |
| Image URL | url |
| Icon | text |
| Custom Icon URL | url |
| Link | url |
| External ID | text |
| Accessor IDs | object |
| User IDs | choice |
| Group IDs | choice |
| Branch Access | boolean |
| Admin IDs | object |
| User IDs | choice |
| Group IDs | choice |
| Inclusions | array |
| Inclusion User IDs | choice |
| Exclusions | array |
| Exclusion User IDs | choice |
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
Update a PageAction
| Field | Type |
|---|---|
Page IDRequired | choice |
| Contents | object |
| English (US) Content | object |
| Space ID | choice |
| Published | boolean |
| External ID | text |
| Reader IDs | choice |
| Admin IDs | choice |
| Field | Type |
|---|---|
| ID | text |
| Owner ID | text |
| Contents | object |
| En us | object |
| De de | object |
| Space ID | text |
| Branch ID | text |
| Created at | date |
| Updated at | date |
| Published at | date |
| Readers | object |
| User ids | array |
| Branch access | boolean |
| Admins | object |
| User ids | array |
| Group ids | array |
| Token ids | array |
Update a UserAction
| Field | Type |
|---|---|
User IDRequired | choice |
EmailRequired | |
| Role | text |
| Status | choice |
| External ID | text |
| Profile | object |
| Property Name | text |
| User Name | text |
| Recovery Code | object |
| Plain | text |
| Expires | text |
| Secret | text |
| Send Mail | boolean |
| Field | Type |
|---|---|
| ID | text |
| Config | object |
| Locale | text |
| Created at | date |
| Activated at | date |
| External ID | text |
| Role | text |
| object | |
| Value | text |
| Source | text |
| Status | text |
| Secret | text |
| Profile | object |
| Property 1 | text |
| Property 2 | text |
| User name | object |
| Value | text |
| Source | text |
Update CSV Import ConfigurationAction
| Field | Type |
|---|---|
Import IDRequired | choice |
| Delta | boolean |
| Generate Recovery Codes | boolean |
| Report Mail Address | |
| Report Only On Errors | boolean |
| Send Mails New | boolean |
| Send Mails Pending | boolean |
| Encoding | choice |
| Partial Tag | text |
| Separator | choice |
| Type | choice |
| Mapping | array |
Update CSV Import StatusAction
| Field | Type |
|---|---|
Import IDRequired | choice |
| State | choice |
Update Group MembersAction
| Field | Type |
|---|---|
Group IDRequired | choice |
| User IDs | choice |
| Field | Type |
|---|---|
| ID | text |
| Accessor ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| Admin ids | object |
| User ids | array |
| Group ids | array |
| Branch access | boolean |
| External ID | text |
| Config | object |
| Localization | object |
| Show in overview | boolean |
| Image URL | text |
| Icon | text |
| Custom icon URL | text |
| Link | text |
| Type | text |
| Creator | object |
| ID | text |
| Type | text |
| Updated at | date |
| Inclusions | array |
| Inclusion user ids | array |
| Exclusions | array |
| Exclusion user ids | array |
Upload a CSV FileAction
| Field | Type |
|---|---|
FileRequired | text |
Templates
Look for Staffbase templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Breathe HR[2]Cloud HR software for employee records, leave, onboarding, and people management.
- BuddyPunchEmployee time clock and attendance tracking for hourly teams.
- BrioHRHR management platform for employee data, leave, payroll-ready records, and people operations.
- Base.vnWorkplace suite for HR, requests, meetings, time off, and team operations.
- CalamariHR leave, attendance, and timesheet management for growing teams.
References
- WEXTL® Staffbase Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Staffbase.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12