Staffbase (Preview)
With the Staffbase Connector, you bridge disparate tools and systems and integrate the Staffbase platform into your automated workflows. That include your employee app or intranet to automate processes, run tasks on a schedule, or notify users when events occur.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Staffbase Support |
| URL | https://www.staffbase.com |
| support@staffbase.com |
| Connector Metadata | |
|---|---|
| Publisher | Staffbase GmbH |
| Website | https://www.staffbase.com |
| Privacy policy | https://staffbase.com/en/privacy-policy/ |
| Categories | Communication;Human Resources |
Staffbase connector
With the Staffbase connector for Power Automate you bridge the gap between different tools and systems and include the Staffbase platform in your automated workflows. Leverage the power of automated workflows that include your employee app or intranet to automate processes, run tasks on a schedule, or notify users as events take place.
Prerequisites
- A Microsoft Power Apps or Power Automate plan with custom connector feature
- A Staffbase license for your organization
- The role of administrator for your organization on the Staffbase platform
- The API token to configure authentication
- Information on which Staffasbe infrastructure your application is hosted on, reach out to support@staffbase.com for more information
Supported Operations
ChannelsGetList
Get a list of news channels
ChannelsGetPosts
Get a list of posts within the specified channel
ChannelsPostPost
Send a post to specific channel
CommentsGet
Get all comments from your Staffbase instance
MediaGet
Get all media from your Staffbase instance
MediaGetByID
Get media by ID
MediaDelete
Delete media by ID
NotificationPost
Sends notification to user(s)
PostsGetAll
Get a list of posts
PostsGetByID
Get a post by ID
PostsDelete
Removes a post
PostsPut
Updates a post
UserGetAll
Get list of users
UserPost
Invite an user by firstname, lastname and eMail
UserGetByID
Get user information
User_delete
Delete User by ID
UserPut
Update user information
UserPostRecovery
Send a recovery email
ProxyVersionGet
Just for internal usage, to check the current API proxy version
Obtaining Credentials
For the basic authentication between your Staffbase platform and the workflow created in Power Automate, you need an API token. You can generate the API token from the Staffbase Experience Studio.
Getting Started
Configure the connector with basic authentication and the hosting URL.
- In Power Automate, navigate to Connectors.
- Search for Staffbase connector.
- Click on the Staffbase connector. A dialog to configure the connector opens.
- In the API Token field, add the API token using the following syntax: Basic [API-Token]
Note: You need to add an empty space between 'Basic' and the API token.
In the Host ID field, enter the identifier for the infrastructure where your Staffbase platform is hosted:
- German infrastructure: de1
- International infrastructure: us1
For detailed information, visit the Staffbase Support Portal.
Known Issues and Limitations
The Staffbase connector currently does not support all Staffbase API features. For more detailed information on Staffbase APIs, visit the Staffbase Developer Portal.
Frequently Asked Questions
What business workflows can be automated using the Staffbase connector?
Many business processes can be automated using the Staffbase connector. For example, notify your employees directly in their employee app or intranet as and when actions take place in other tools. Learn more about such business use cases here.
Are there tutorials to help me get started with an automated workflow using the Staffbase connector?
Staffbase offers tutorials that use our Forms plugin and the Staffbase connector to automate your facility management. Learn all about how to set it up in this section.
Deployment Instructions
Run the following commands and follow the prompts:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API-Key | securestring | "API-Key" for the Staffbase instance | True |
| Hosting ID | string | Specify your hosting ID: hostingID | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Channels: Get a list of news channels |
Get a list of news channels. |
| Channels: Get a list of posts within the specified channel |
Get a list of posts within the specified channel. |
| Channels: Send a post to specific channel |
Send a post to specific news channel. |
| Media: Delete media |
Deletes the specified media in the current context. |
| Media: Get all media |
Requests description of all media available in the current context. |
| Media: Get media by ID |
Get metadata for single media by its ID. |
| Notification: Sends notification |
Sends notifications to specified user(s). |
| Posts: Get a list of posts |
Get a list of posts that are accessible for the API token. |
| Posts: Get a post by ID |
Requests the specified posts including a set of comments. |
| Posts: Get comments |
Get a list of comments. |
| Posts: Removes a post |
Removes a post from the system. |
| Posts: Updates a post |
Updates a post, only changed field (incremental). |
| Proxy: Get version |
Returns the current proxy version. |
| User: Delete User |
Deletes the specified user. |
| User: Get list of users |
Get a list of users, depending on the API access token. |
| User: Get user information |
Get specific user information by its user id. |
| User: Invite user |
The user will receive an email to signup. |
| User: Send a recovery email |
Sends a recovery email to the specified user. |
| User: Update user information |
Update user information. |
Channels: Get a list of news channels
Get a list of news channels.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer |
Total number of channels that are found. |
|
limit
|
limit | integer |
The amount of items that are returned. |
|
offset
|
offset | integer |
The current defined offset for getting the items starting at this number. |
|
data
|
data | array of object | |
|
id
|
data.id | string |
This is the ID of the channel. |
|
localization
|
data.config.localization | array of object | |
|
title
|
data.config.localization.title | string |
The channel title which is localized. |
|
locale
|
data.config.localization.locale | string |
This is the locale of channel title. |
|
spaceID
|
data.spaceID | string |
The ID of the space where the channel is assigned to. |
|
created
|
data.created | string |
The created date of the channel. |
|
published
|
data.published | string |
The published date of the channel. |
|
updated
|
data.updated | string |
The updated date of the channel. |
Channels: Get a list of posts within the specified channel
Get a list of posts within the specified channel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ChannelID
|
channelID | True | string |
Insert channel ID here, e.g. retrieved by getChannels. |
|
Limit
|
limit | integer |
The amount of items that should be returned (default and maximum 100). |
|
|
Offset
|
offset | integer |
Define an offset for getting the items starting at this number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer |
Total number of posts that are found. |
|
limit
|
limit | integer |
The amount of items that are returned. |
|
offset
|
offset | integer |
The current defined offset for getting the items starting at this number. |
|
data
|
data | array of postData |
Channels: Send a post to specific channel
Send a post to specific news channel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ChannelID
|
channelID | True | string |
Insert channel ID here. |
|
externalID
|
externalID | string |
Optional: Enter an external ID here. |
|
|
locale
|
locale | string |
Insert locale like, e.g. de_DE, en_US, etc. |
|
|
content
|
content | string |
Enter news content here. |
|
|
image (link)
|
image | string |
Enter image link here. |
|
|
teaser
|
teaser | string |
Enter your teaser here. |
|
|
title
|
title | string |
Enter your title here. |
|
|
published
|
published | string |
Enter your date published here. |
Returns
Media: Delete media
Deletes the specified media in the current context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
MediumID
|
mediumID | True | string |
Deletes the medium by its ID. While this will immediately remove the resource from our servers, the CDN may still deliver the content via the URL stated in resourceInfo.url until CDN invalidation. |
Returns
Media: Get all media
Requests description of all media available in the current context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limit the number of items here. |
|
|
Offset
|
offset | integer |
Set an offset for the query. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer |
Total number of assets that are found. |
|
limit
|
limit | integer |
The amount of items that are returned. |
|
offset
|
offset | integer |
The current defined offset for getting the items starting at this number. |
|
data
|
data | array of mediaData |
Media: Get media by ID
Get metadata for single media by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
MediumID
|
mediumID | True | string |
Requests information on a specific medium. |
Returns
- Body
- mediaData
Notification: Sends notification
Sends notifications to specified user(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
accessorIds
|
accessorIds | array of string | ||
|
locale
|
locale | string |
Insert locale like, e.g. de_DE, en_US, etc. |
|
|
title
|
title | string |
Insert language dependent title. |
|
|
link
|
link | string |
Optinal: Insert link here. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
This is the ID of the notification. |
|
accessorIds
|
recipients.accessorIds | array of string |
This is the list of recipients IDs. |
|
content
|
content | array of object | |
|
title
|
content.title | string |
The title of the notification which is localized. |
|
locale
|
content.locale | string |
This is the locale of the title. |
|
link
|
link | string |
This is the notification link. |
|
type
|
type | string |
This is the notification type. |
|
createdAt
|
createdAt | string |
The created date of the notification. |
|
created
|
created | string |
The created date of the notification. |
Posts: Get a list of posts
Get a list of posts that are accessible for the API token.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Query
|
query | string |
A string that can be used for searching the post content. |
|
|
Limit
|
limit | integer |
The amount of items that should be returned (default and maximum 100). |
|
|
Offset
|
offset | integer |
Define an offset for getting the items starting at this number. |
|
|
Manageable
|
manageable | boolean |
Optional filter for the given post content types. Defaults to not filtering. |
|
|
ContentType
|
contentType | string |
Optional filter for the given post content types. (Defaults to not filtering) |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer |
Total number of posts that are found. |
|
limit
|
limit | integer |
The amount of items that are returned. |
|
offset
|
offset | integer |
The current defined offset for getting the items starting at this number. |
|
data
|
data | array of postData |
Posts: Get a post by ID
Requests the specified posts including a set of comments.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
This is the ID of the post. |
Returns
- Body
- postData
Posts: Get comments
Get a list of comments.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Manage
|
manage | boolean |
When true and the token role allows manage comments - also not published comments will be shown in the list. |
|
|
Limit
|
limit | integer |
The amount of items that should be returned (default and maximum 100). |
|
|
Offset
|
offset | integer |
Define an offset for getting the items starting at this number. |
|
|
Filter
|
filter | string |
Filter in SCIM2 format with partial support. For now only flat structure (no nested clauses) and comparison clauses like eq = "equals", gt = "greater than", ge = "greater than or equals", lt = "less than", le = "less than or equals" are supported. For comments supported filter fields are: created and updated. The value for these fields can be provided in UTC DateTime string representatiion or long number of milliseconds of Unix epoch. Example 1: filter=updated ge "2020-11-26T10:14:48.947Z" and updated le "2020-11-26T10:14:48.947Z". In this example the DateTime range filter is applied to updated field with ge and le comparison clauses and and boolean clause. Example 2: filter=created gt "2020-11-26T10:14:48.947Z". Get all comments, created after pointed date. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
total
|
total | integer |
Total number of comments that are found. |
|
limit
|
limit | integer |
The amount of items that are returned. |
|
offset
|
offset | integer |
The current defined offset for getting the items starting at this number. |
|
data
|
data | array of object | |
|
id
|
data.id | string |
This is the ID of the comment. |
|
parentID
|
data.parentID | string |
The ID of the parent of the comment, can be either a post or a comment. |
|
parentType
|
data.parentType | string |
The parent type can be either a post or a comment. |
|
comment text
|
data.text | string |
This is the comments content / test itself. |
|
post ID
|
data.rootID | string |
This is the ID of the post this comment is related to |
|
author
|
data.author | authorObject | |
|
total
|
data.likes.total | integer |
This is the number of comment likes. |
|
isLiked
|
data.likes.isLiked | string |
Is this comment liked? |
|
created
|
data.created | string |
The created date of the comment. |
|
updated
|
data.updated | string |
The updated date of the comment. |
|
image
|
data.image | imageObject |
Posts: Removes a post
Removes a post from the system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
This could be either the post ID defined by the API or if set the post externalID. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
identifier
|
identifier | integer |
The Identifier of deletion. |
|
statusCode
|
statusCode | integer |
The status code of the action. |
|
message
|
message | string |
The message of the action. |
|
type
|
type | string |
The type of the action. |
Posts: Updates a post
Updates a post, only changed field (incremental).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
PageID
|
pageID | True | string |
This could be either the post ID defined by the API or if set the post externalID. |
|
externalID
|
externalID | string |
Optional: Enter an external ID here. |
|
|
locale
|
locale | string |
Insert locale like, e.g. de_DE, en_US, etc. |
|
|
content
|
content | string |
Enter news content here. |
|
|
image
|
image | string |
Enter link to image here. |
|
|
teaser
|
teaser | string |
Enter your teaser here. |
|
|
title
|
title | string |
Enter your title here. |
|
|
published
|
published | string |
Enter your date published here. |
Returns
Proxy: Get version
Returns the current proxy version.
Returns
User: Delete User
Deletes the specified user.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
The ID can be based on either the UserID automatically generated by the Staffbase platform or the externalID, if it is added for the user. |
Returns
User: Get list of users
Get a list of users, depending on the API access token.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
SCIM notation can be used to filter
|
filter | string |
SCIM notation can be used to filter. |
|
|
The fulltext search can be combined with the filter
|
query | string |
Here you can serach in any profile field. |
Returns
User: Get user information
Get specific user information by its user id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
The ID can be based on either the UserID automatically generated by the Staffbase platform or the externalID, if it is added for the user. |
Returns
- Body
- userData
User: Invite user
The user will receive an email to signup.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
email
|
string |
This is the email address of the user. |
||
|
firstName
|
firstName | string |
This is the firstname of the user. |
|
|
lastName
|
lastName | string |
This is the lastname of the user. |
Returns
User: Send a recovery email
Sends a recovery email to the specified user.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
The ID can be based on either the UserID automatically generated by the Staffbase platform or the externalID, if it is added for the user. |
Returns
User: Update user information
Update user information.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
UserID
|
userID | True | string |
The ID can be based on either the UserID automatically generated by the Staffbase platform or the externalID, if it is added for the user. |
|
id
|
id | string |
The ID of the user |
|
|
externalID
|
externalID | string |
The external ID of the user |
|
|
firstName
|
firstName | string |
The firstname of the user |
|
|
lastName
|
lastName | string |
The lastname of the user |
|
|
publicEmailAddress
|
publicEmailAddress | string |
The public eMail of the user |
|
|
locale
|
locale | string |
The locale of the user |
|
|
email
|
value | string |
The email address |
|
|
primary
|
primary | boolean |
Is it the primary email? |
|
|
groupIDs
|
groupIDs | array of string | ||
|
position
|
position | string |
The position of the user |
|
|
department
|
department | string |
The department of the user |
|
|
location
|
location | string |
The location of the user |
|
|
phoneNumber
|
phoneNumber | string |
The phone number of the user |
|
|
created
|
created | string |
The created date of the user |
|
|
updated
|
updated | string |
The updated date of the user |
|
|
activated
|
activated | string |
Is the user activated? |
Returns
- Body
- userData
Definitions
mediaData
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
This is the ID of the asset. |
|
ownerID
|
ownerID | string |
This is the ID of the owner of this asset. |
|
parentID
|
parentID | string |
This is the ID of the parent media asset. |
|
publicID
|
publicID | string |
This is the public ID for accessing the asset. |
|
type
|
resourceInfo.type | string |
This is the asset resource type. |
|
bytes
|
resourceInfo.bytes | integer |
This is the resource size (in bytes). |
|
width
|
resourceInfo.width | integer |
This is the resource width. |
|
height
|
resourceInfo.height | integer |
This is the resource height. |
|
url
|
resourceInfo.url | string |
This is the resource url. |
|
format
|
resourceInfo.format | string |
This is the resource format. |
|
mimeType
|
resourceInfo.mimeType | string |
This is the resource MIME type. |
|
fileName
|
fileName | string |
This is the media filename. |
|
title
|
title | string |
This is the media title. |
|
label
|
label | string |
This is the media label. |
|
created
|
created | string |
The created date of the asset. |
userData
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
The ID of the user |
|
externalID
|
externalID | string |
The external ID of the user |
|
firstName
|
firstName | string |
The firstname of the user |
|
lastName
|
lastName | string |
The lastname of the user |
|
publicEmailAddress
|
publicEmailAddress | string |
The public eMail of the user |
|
locale
|
config.locale | string |
The locale of the user |
|
emails
|
emails | array of object |
User email information |
|
email
|
emails.value | string |
The email address |
|
primary
|
emails.primary | boolean |
Is it the primary email? |
|
groupIDs
|
groupIDs | array of string | |
|
position
|
position | string |
The position of the user |
|
department
|
department | string |
The department of the user |
|
location
|
location | string |
The location of the user |
|
phoneNumber
|
phoneNumber | string |
The phone number of the user |
|
created
|
created | string |
The created date of the user |
|
updated
|
updated | string |
The updated date of the user |
|
activated
|
activated | string |
Is the user activated? |
postData
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
The ID of the post. |
|
author
|
author | authorObject | |
|
contents
|
contents | array of object | |
|
content
|
contents.content | string |
The post content, which is localized. |
|
image
|
contents.image | imageObject | |
|
teaser
|
contents.teaser | string |
The post teaser, which is localized. |
|
title
|
contents.title | string |
The post title, which is localized. |
|
locale
|
contents.locale | string |
This is the locale of the item. |
|
id
|
channel.id | string |
This is the ID of the channel. |
|
localization
|
channel.config.localization | array of object | |
|
title
|
channel.config.localization.title | string |
This is the channel title, which is localized. |
|
locale
|
channel.config.localization.locale | string |
This is the locale of the channel title. |
|
published
|
published | string |
The published date of the post. |
|
created
|
created | string |
The created date of the post. |
|
updated
|
updated | string |
The updated date of the post. |
authorObject
| Name | Path | Type | Description |
|---|---|---|---|
|
firstName
|
firstName | string |
This is the firstname of the author. |
|
id
|
id | string |
This is the ID of the author. |
|
lastName
|
lastName | string |
This is the lastname of the author. |
|
url
|
avatar.original.url | string |
This is the author avatar image original url. |
|
width
|
avatar.original.width | integer |
This is the author avatar image original width. |
|
height
|
avatar.original.height | integer |
This is the author avatar image original height. |
|
size
|
avatar.original.size | integer |
This is the author avatar image original sie (in bytes). |
|
format
|
avatar.original.format | string |
This is the author avatar original format. |
|
mimeType
|
avatar.original.mimeType | string |
This is the athor avatar image original mimeType. |
|
created
|
avatar.original.created | string |
This is the author avatar original created date. |
|
url
|
avatar.icon.url | string |
This is the author avatar icon url. |
|
width
|
avatar.icon.width | integer |
This is the author avatar icon width. |
|
height
|
avatar.icon.height | integer |
This is the author avatar icon height. |
|
format
|
avatar.icon.format | string |
This is the author avatar icon format. |
|
mimeType
|
avatar.icon.mimeType | string |
This is the author avatar icon mimeType. |
|
url
|
avatar.thumb.url | string |
This is the author avatar thumb url. |
|
width
|
avatar.thumb.width | integer |
This is the author avatar thumb width. |
|
height
|
avatar.thumb.height | integer |
This is the author avatar thumb height. |
|
format
|
avatar.thumb.format | string |
This is the author avatar thumb format. |
|
mimeType
|
avatar.thumb.mimeType | string |
This is the athor avatar thumb mimeType. |
|
publicID
|
avatar.publicID | string |
This is the author avatar public ID. |
imageObject
| Name | Path | Type | Description |
|---|---|---|---|
|
url
|
original.url | string |
This is the image original url. |
|
width
|
original.width | integer |
This is the image original width. |
|
height
|
original.height | integer |
This is the image original height. |
|
size
|
original.size | integer |
This is the image original size (in bytes). |
|
format
|
original.format | string |
This is the image original format. |
|
mimeType
|
original.mimeType | string |
This is the image original mimeType. |
|
url
|
original_scaled.url | string |
This is the image original url. |
|
width
|
original_scaled.width | integer |
This is the image original width. |
|
height
|
original_scaled.height | integer |
This is the image original height. |
|
format
|
original_scaled.format | string |
This is the image original format. |
|
mimeType
|
original_scaled.mimeType | string |
This is the image original mimeType. |
|
url
|
compact.url | string |
This is the image compact url. |
|
width
|
compact.width | integer |
This is the image compact width. |
|
height
|
compact.height | integer |
This is the image compact height. |
|
format
|
compact.format | string |
This is the image compact format. |
|
mimeType
|
compact.mimeType | string |
This is the image compact mimeType. |