API Server 7.x to 8.x

API Server 7.x to 8.x

Migrate your 7.x API Server to the latest 8.x API Server with ease by following our update guide.

8.x Breaking Changes

There are a few breaking changes with this upgrade you should be aware of:

Developer Portal Users

Admin accounts work as they do in 7.x where Admins can Create new Projects and Teams.

There is an automatic update hook upon upgrade to API 8.0.0 that affects the original user created with the environment variables ADMIN_EMAIL and ADMIN_PASS. The update hook migrates this original user from the User Resource to the Admin Resource in the Portal Base Project.

Any external scripts that assume the User resource to contain this user would need to be updated to point to the Admin resource.

Webhook Improvements

Payload Transformations

Modify the data payload being sent by the Webhook before it is sent using JavaScript. This allows you to alter the payload to map to any external service interfaces.

Proper Error Handling and Logging

The webhook action now features improved handling of errors and logging to ensure that there is visibility into how the webhook is operating when pointed to the 3rd party services.

Action Deprecation: Because of the Webhook Improvements, it is now possible to integrate with a wide variety of 3rd party services using nothing more than the Webhook action, resulting in several existing integration actions now being redundant. With this in mind, the following action items are being deprecated:

Deprecated actions have been removed from the Portal UI but will still function on forms where the action was previously configured

Actions: Office 365, Jira, Twillio, Hubspot

These actions will be removed in favor of the Webhook Action

Action: Reset Password

Customers are encouraged to utilize our Reset Password workflow solution.

Dropbox integration

Our webhooks allow customers the flexibility to use whichever services they wish to integrate

Signature Relocation

With the addition of Box Sign, the signature component has been relocated to the Premium components tab.

8.x Features

There are also many new features included in this release designed to provide Form.io users with reliability, platform extensibility, and (more) ease of use. Please check out these new capabilities below:

Portal Admin Permissions

Portal Admins now have full visibility and access to all projects within the Form.io Developer Portal, regardless of who created them. This includes viewing all Environment Project Stages for the deployment, even if the parent Project does not reside within that specific environment.

Previously, any user with access to the Form.io Developer Portal could create their own projects, but these projects were only visible to their creators. This lack of visibility extended to Portal Admins, making it difficult to manage and control the number of active projects under a license.

To resolve this, we have introduced two distinct roles within the Form.io Developer Portal: Admins and Authenticated Users, each with specific project creation permissions and capabilities.

Additionally, Authenticated Users can now be configured to restrict their ability to create Projects and Teams by adding the following environment variable for the Enterprise API Server. ONLY_PRIMARY_WRITE_ACCESS.

Form Building and Form Management:

Google Drive Integration

Use Google Drive as storage for the file component.

Google Sheet action to create and update fields within your own Google Sheets.

Migration of Form Revisions

Form Revisions now migrate to destination stages during Stage Deployments. All references to revisions within nested form definitions are updated to include the correct revisions that are being transferred.

Two Factor Authentication

2FA can now be enabled for logging into the Developer portal as well as on a per-project basis to enable 2FA within your application.

Populate Resources and Forms from CSV

Form.io now enables an easy-to-use CSV Upload Feature within the Developer Portal to pre-populate Submissions against any Form or Resource with a single click of a button!

New Conditional Show & Hide

As of server release 8.1.0, Form.io has released a code-free Conditional Show/Hide UI using simple dropdown fields. This update relieves the need to write custom Javascript when the Show/Hide workflow is dependent on multiple fields or values. Read More Here

Form.io Security & Compliance Module:

Submission Revisions, Custom Collections, Localization of the Developer Portal, and more! Read More Here

If you are using any features that are within the Security Module, please ensure you have this Module as part of your subscription in order to use these features. Please send us an email if you have any questions, or to have this module added to your subscription here: [email protected].

Internal Process Improvements:

Form.io has automated over 90% of our testing suite to increase our agility and performance for our customers

Last updated

Was this helpful?