Changelog

December 10, 2024

• Starting December 10, 2024, Staffbase will discontinue support for the following generic URLs as reply URLs:
  • de.eyo.net (DE)
  • backend.staffbase.com (US)

If you use any of these domains as reply URLs, you must update your Identity Provider (IdP) settings with your Staffbase platform domain to the list of allowed reply URLs. This is essential to avoid disruptions to your API integrations and SAML-SSO authentication flow. If you are impacted, your Customer Success Manager or Support team will reach out to you to assist you further.

October 17, 2024

• Pages API: The Pages API simplifies creating new pages with content from external sources, making it ideal for organizations migrating to the Staffbase platform or consolidating scattered information. It helps preserve valuable content and ensures a seamless transition during migration. Additionally, you can manage your pages using the Pages API.
  Learn more about the Pages API use cases:

  • Extract Page Content Using the Pages API
  • Import External Content to Pages

• File Management API: Introducing File Management API that offers a range of methods to streamline file management tasks on your platform, such as adding files to your File Manager and creating, updating, or deleting collections. Whether you need to import assets from an external source, set up files for a new editor, or manage collections centrally as an administrator, the File Management API makes it simple and efficient. Learn more on getting started with the File Mangement API.

• Spaces API: The Spaces API simplifies creating and managing Spaces in your platform. It brings enhanced felxiblity and automation, allowing you to integrate Spaces management into your workflows.

September 17, 2024

• In the Notifications API, a new error code has been added to the response of the Send notifications endpoint. The error code 429 is returned when too many requests are sent in parallel and exceeds the rate limits. When this error occurs, wait a short period before retrying the request. To avoid this error, we recommend staggering API calls instead of sending them all at once.

• In the Campaigns API, the Create campaign references endpoint now returns the plannedAt parameter. This parameter shows at what time and date the post is planned to be published and it is returned with the response body. The plannedAt parameter provides a date and time in ISO 8601 format. For example, 2024-09-17T12:00:00Z.

August 31, 2024

• In the User API, the enabled, pending, and verificationCode response fields of a user have been removed, as announced last year. To access the same information, use the following properties instead:
  • status
  • secret

For more information, see the migration guide.

July 30, 2024

• In the Campaigns API, there are now two new endpoints available for adding and removing content pieces as references. They are:
• Create a campaign reference
• Delete a campaign reference

July 17, 2024

• It is now possible to use the vertical bar | as a CSV separator in the (New) CSV Import API.

May 16, 2024

• Introducing the (New) CSV Import API that offers advanced functionalities and an improved user experience. To get started, see the Get Started With New CSV Import guide. Use this beta feature instead of the (Legacy) CSV Import API, which is planned to be deprecated in the future. Staffbase strongly recommends migrating to the new CSV Import API as soon as possible. Learn more.

• Introducing the Quick Links API that allows you to add custom header links to enable quick access to content for your users. Learn more.

April 9, 2024

• In Campaigns API, the sort parameter has been improved. Now, you have the following enum values for the sort parameter:
• updated_DESC - Sort the reference list in descending order based on the last updated date
• created_DESC - Sort the references attached to a campaign based on the date they were created in descending order, from newest to oldest.
• updated_ASC - Sort the references attached to a campaign based on the date they were last updated in ascending order, from oldest to newest.
• scheduledFor_ASC - Sort the reference list in ascending order based on the publishing order.
• scheduledFor_DESC - Sort the reference list in descending order based on the publishing order.
  In addition, the default value has been changed from updated_DESC to created_DESC.

March 6, 2024

• If you use SAML SSO, you now have the option to configure the SAML domain hints. These hints ensure that users don’t attempt to authenticate with the identity provider (IdP) using domains that are not allowed when using the Staffbase platform. To activate this feature, contact Staffbase Support or your Customer Success Manager. It’s worth noting that this feature currently works with Microsoft Entra ID as the IdP, although it may also work with other IdPs.

March 5, 2024

• The content types multipart/form-data and application/x-www-form-urlencoded have been removed from the Chat API.

February 19, 2024

• The user/tags endpoint under the User API has been removed. You can use Tags API instead.

December 31, 2023

• The Leave Webservice and Shift Webservice are no longer available as public Staffbase APIs.

December 1, 2023

• The Profile API is no longer available as a public Staffbase API. You can use User API for the same purposes. Contact Staffbase Support or your Customer Success Manager for more information.

October 25, 2023

• When updating pending user details with the User API, the profile fields were not populated. This has been fixed quickly.

August 31, 2023

• In User API, the verificationCode, pending and enabled response fields of a user account will be removed until 31/08/2024. Instead, you can now use:
• secret for the verificationCode response field
• status for the pending and enabled response fields
• It also replaced the enabled property with the status property to enable or disable a user with a request.

To migrate to the new properties, see the migration guide.

August 10, 2023

• Introducing Tags API for more scalable and user-friendly format for returning tags used in user profiles. The Tags API will replace the user/tags endpoint under the User API. The user/tags endpoint will soon be removed. If you are still using user/tags endpoint, Staffbase recommends migrating to the Tags API.

• Introducing a new addition to the Analytics API: the User timeseries endpoint. This endpoint returns information on total, registered, active, and engaged users for a specific time frame. It comes with significant improvements, offering enhanced functionality and improved performance to ensure your integrations are future-proof.
  As part of this update, the existing User timeseries with SCIM endpoint will be deprecated. Staffbase will continue to support this endpoint until the beginning of 2024, after which it will no longer be supported. Staffbase recommends migrating to the User timeseries endpoint.

July 14, 2023

• Users and tokens assigned as editors on a specific plugin could set properties via API on these plugins, which exceeded their permission level. This has been fixed. Now, users and tokens with editorial access for specific plugins can only set the plugin properties available to them in the Studio user interface.

June 16, 2023

• In User API, the source response field of a user has been removed. Instead, you can now use the creation response field.

May 11, 2023

• Introducing Contact API that allows you to sync your recipients’ email addresses and other attributes from any third-party human resources system directly into Employee Email for creating custom distribution lists.

April 13, 2023

• In User API, the creation date of the user account got incorrectly overwritten with the activation date. This has been fixed.

February 9, 2023

• In News, when the User API was used to search for posts, acknowledgments were not displayed. This has been fixed.