Pre-Built Tooling
Category | Details |
---|---|
Authentication | OAuth 2.0 (Authorization Code with refresh tokens) |
Two-Way Sync | No |
Events Supported | No |
Realtime | No (Polling) |
Supports Rate Limiting | Yes |
Authentication Scopes Supported | companies:read , payrolls:read , employee_time_off_activities:read , employees:read , jobs:read , jobs:write , webhook_subscriptions:write , webhook_subscriptions:read |
Objects Supported
Alloy Automation supports syncing the following objects from Gusto:- Companies
- Employees
- Payrolls
- Jobs
- Employee Time Off Activities
- Webhook Subscriptions
Set Up Guide
Trial Access
Question | Answer |
---|---|
Offers free trial? | Gusto does not offer a traditional free trial. However, you can request a demo and learn about their partnership program at https://gusto.com/partners. |
Requires paid sandbox? | Yes. Gusto provides a demo/sandbox environment for partners and developers, but access requires approval. |
Requires partnership to obtain authentication? | Yes. API access requires joining Gusto’s Partner Program and being approved as a partner. |
Authentication (OAuth 2.0)
For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation’s.Create your OAuth app (Gusto Developer Portal)
- Apply to join the Gusto Partner Program at https://gusto.com/partners
- Once approved, access the Gusto Developer Portal at https://dev.gusto.com/
- Navigate to My Applications and click Create New Application
- Fill in your application details:
- Application Name
- Application Description
- Company Website
- Add the redirect URI:
https://api.runalloy.com/api/strategy/connector/gusto/callback
- Select the scopes you need:
companies:read
(Read company information)employees:read
(Read employee information)payrolls:read
(Read payroll data)jobs:read
(Read job/position information)jobs:write
(Create and update jobs)employee_time_off_activities:read
(Read time-off requests)webhook_subscriptions:read
(Read webhook subscriptions)webhook_subscriptions:write
(Manage webhook subscriptions)
- Copy your Client ID and Client Secret into Alloy Automation
- Complete Gusto’s security review process before going to production
OAuth Flow
- Authorization URL:
https://api.gusto.com/oauth/authorize
- Token URL:
https://api.gusto.com/oauth/token
- Gusto uses standard OAuth 2.0 authorization code flow
- Access tokens expire and must be refreshed using refresh tokens
Getting Started
- Gusto Partner Program: https://gusto.com/partners
- Developer Portal: https://dev.gusto.com/
- API Documentation: https://docs.gusto.com/
- API Reference: https://docs.gusto.com/v1/
Use Cases
1) HRIS data synchronization
Sync employee records, compensation details, and organizational structure from Gusto to your internal HR systems or data warehouse, maintaining a single source of truth for employee information across platforms.2) Payroll data integration
Automatically extract payroll run data, tax information, and payment details into your financial systems for reconciliation, reporting, and compliance tracking without manual data entry.3) Time-off management
Integrate time-off requests and balances from Gusto with your project management or resource planning tools to ensure accurate availability tracking and workload distribution.4) Onboarding and offboarding automation
Trigger workflows in other systems (email, IT provisioning, equipment ordering) based on new hire data from Gusto or automatically archive employee records across systems when someone leaves.5) Benefits administration tracking
Monitor employee benefits enrollment, changes, and costs by syncing benefits data from Gusto to your benefits administration platform or financial reporting systems.API Gotchas
- Partner program requirement: Unlike many APIs, Gusto requires formal partnership approval before you can access the API. Plan for several weeks of lead time to complete the application and approval process.
- Sandbox environment access: The demo/sandbox environment may have limited data and functionality compared to production. Request sandbox access early in your development process.
- Rate limiting: Gusto enforces rate limits on API requests. Implement exponential backoff and respect rate limit headers. Contact your partner manager if you need higher limits for production use.
- Company-scoped authentication: OAuth tokens are scoped to specific companies. If a user has access to multiple companies, you’ll need separate authorizations for each company they want to connect.
- PII and compliance: Gusto handles sensitive HR and payroll data. Ensure your application complies with data protection regulations (GDPR, CCPA, etc.) and follows Gusto’s data handling requirements.
For questions or troubleshooting, contact support@runalloy.com.