README.md

🦎 Gusto Embedded React SDK

To install:

npm add @gusto/embedded-react-sdk

SDK Dev App

A standalone development application for building and testing SDK components with live API data is available in sdk-app/. To get started:

npm run sdk-app              # Demo environment (default)
npm run sdk-app:staging      # Staging environment

See the SDK Dev App README for full setup and usage details.

Documentation

• Deciding to build with the SDK
  • Build Pathways - SDK, Flows & APIs
  • Component Types
• Getting Started
  • Authentication
• Integration Guide
  • Versioning
  • Event Handling
  • Event Types
  • Error Handling
  • Composition
  • Providing your own data
  • Translation
  • Routing
  • Request Interceptors
  • Customizing SDK UI
  • Observability
  • Observability Examples
• Theming
  • Theming Guide
  • Theme Variables
• Component Adapter
  • How the Component Adapter Works
  • Component Adapter Types
  • Setting up your Component Adapter
  • Component Inventory
  • Component Adapter FAQ
• Appendix
  • Endpoint Reference
  • Jobs and Compensations
  • Reviewing SDK API access
• Workflows Overview
  • Company Onboarding
  • Contractor Onboarding
  • Contractor Payments
  • Employee Onboarding
    • Employee Self-Onboarding
  • Employee Dashboard
  • Employee Termination
  • Information Requests
  • Run Payroll
  • Off-Cycle Payroll (Bonus & Correction)
  • Dismissal Payroll
  • Transition Payroll

License

Licensed under the Apache License 2.0 — see LICENSE. Use of the Gusto Embedded Payroll API and related Gusto services is governed separately; see DISCLAIMER.md.

For the terms that apply to contributions, see CONTRIBUTING.md.