React SDK

The Gusto Embedded Payroll React SDK offers component libraries with built-in business logic that helps our developers with the complexity of building with payroll APIs.

The React SDK complements our existing iframe components (“Flows”) and underlying APIs.

Documentation

📘

How can I learn more about the React SDK?

Go to our GitHub documentation at https://github.com/Gusto/embedded-react-sdk

As a Gusto Embedded partner, we will provide consultation with a GEP Solutions Architect to ensure we can find the right solution for you. We recommend that you start with the documentation on GitHub, and then reach out to your Gusto Embedded representative to learn more!

How do I know if the GEP React SDK is right for me?

While it’s possible to mix and match the build approach across the domain of your payroll application, you would still generally want to match your needs to the best approach out of the possible build options (SDK, Flows, or build your own UI) for any given domain within the payroll application. As our SDK components are still in an early phase of development, many components may not yet be available via SDK (discuss with your Gusto point of contact if you’d like to inquire about a specific component).

Here are some considerations when deciding whether or not to use the React SDK for any given payroll workflow for your application:

When to use the React SDK

If you:

• Already use React in your application, or are open to introducing React into your stack (Learn how to add React to existing projects)
• Want to use pre-built components that abstract API endpoint complexity
• Already capture info required for a particular workflow (e.g. company onboarding)
• Want to customize components to your application’s theme and layout
• Are just starting out with building embedded payroll on GEP, or the components you want to use are currently available via the SDK library

When to consider another build approach

You may benefit from a different build approach if you:

• Need to deploy a proof of concept as soon as possible, even if the resulting application feels inconsistent in look and feel and non-integrated with the rest of your application (e.g. data that you already have may be requested again).
  • If your number one priority is speed, you may need to use Flows instead, as it is still the fastest way to deploy any given workflow.
• Have very deep customization needs that may not be met by the React SDK (if in doubt, ask your Gusto Embedded point of contact!). You may need to create a custom, API-only build to accommodate your requirements, but we would still highly recommend using SDK or Flow components where possible to reduce your build workload.
• Need an SDK component that does not yet exist: we are actively working on several components to cover the rest of our application.
• For what’s currently available, see the Workflows Overview section and reach out to your Gusto Embedded point of contact for more information!