Skip to content

[CON-3072] feat(gusto): extend provider guide #616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
immdipu merged 3 commits into from
Jun 2, 2026
Merged

[CON-3072] feat(gusto): extend provider guide #616

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a85450a
docs(gusto): enhance documentation with supported actions and objects
immdipu May 27, 2026
6ce487d
docs(gusto): update example integration link for clarity
immdipu May 27, 2026
6b44469
Potential fix for pull request finding
immdipu May 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 52 additions & 12 deletions src/provider-guides/gusto.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,60 @@ title: Gusto

This connector supports:

- [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported, a full read of the Gusto instance will be done for each scheduled read.
Comment thread
immdipu marked this conversation as resolved.
- [Write Actions](/write-actions).
- [Proxy Actions](/proxy-actions), using the base URL `https://api.gusto.com`.

### Supported objects

The Gusto connector supports reading from the following objects:

- [admins](https://docs.gusto.com/app-integrations/reference)
- [companies](https://docs.gusto.com/app-integrations/reference)
- [company_benefits](https://docs.gusto.com/app-integrations/reference)
- [contractor_payments](https://docs.gusto.com/app-integrations/reference)
- [contractors](https://docs.gusto.com/app-integrations/reference)
- [custom_fields](https://docs.gusto.com/app-integrations/reference)
- [departments](https://docs.gusto.com/app-integrations/reference)
- [earning_types](https://docs.gusto.com/app-integrations/reference)
- [employee_benefits](https://docs.gusto.com/app-integrations/reference)
- [employees](https://docs.gusto.com/app-integrations/reference)
- [garnishments](https://docs.gusto.com/app-integrations/reference)
- [home_addresses](https://docs.gusto.com/app-integrations/reference)
- [jobs](https://docs.gusto.com/app-integrations/reference)
- [locations](https://docs.gusto.com/app-integrations/reference)
- [pay_periods](https://docs.gusto.com/app-integrations/reference)
- [pay_schedules](https://docs.gusto.com/app-integrations/reference)
- [payrolls](https://docs.gusto.com/app-integrations/reference)
- [time_off_activities](https://docs.gusto.com/app-integrations/reference)
- [work_addresses](https://docs.gusto.com/app-integrations/reference)

The Gusto connector supports writing to the following objects:

- [admins](https://docs.gusto.com/app-integrations/reference)
- [companies](https://docs.gusto.com/app-integrations/reference)
- [company_benefits](https://docs.gusto.com/app-integrations/reference)
- [compensations](https://docs.gusto.com/app-integrations/reference)
- [contractor_payments](https://docs.gusto.com/app-integrations/reference)
- [contractors](https://docs.gusto.com/app-integrations/reference)
- [departments](https://docs.gusto.com/app-integrations/reference)
- [earning_types](https://docs.gusto.com/app-integrations/reference)
- [employee_benefits](https://docs.gusto.com/app-integrations/reference)
- [employees](https://docs.gusto.com/app-integrations/reference)
- [garnishments](https://docs.gusto.com/app-integrations/reference)
- [home_addresses](https://docs.gusto.com/app-integrations/reference)
- [jobs](https://docs.gusto.com/app-integrations/reference)
- [locations](https://docs.gusto.com/app-integrations/reference)
- [pay_periods](https://docs.gusto.com/app-integrations/reference)
- [pay_schedules](https://docs.gusto.com/app-integrations/reference)
- [payrolls](https://docs.gusto.com/app-integrations/reference)
- [work_addresses](https://docs.gusto.com/app-integrations/reference)


### Example integration

To define an integration for Gusto, create a manifest file that looks like this:
### Example integration

```YAML
# amp.yaml
specVersion: 1.0.0
integrations:
- name: gusto-integration
displayName: My Gusto Integration
provider: gusto
proxy:
enabled: true
```
For an example manifest file of a Gusto integration, visit our [samples repo on GitHub](https://github.com/amp-labs/samples/blob/main/gusto/amp.yaml).

## Before you get started

Expand Down Expand Up @@ -75,6 +112,9 @@ To start integrating with Gusto:

- Create a manifest file like the [example above](#example-integration).
- Deploy it using the [amp CLI](/cli/overview).
- If you are using Read Actions, create a [destination](/destinations).
- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for OAuth authorization.
- Start using the connector!
- If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
Comment thread
immdipu marked this conversation as resolved.
- If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
- If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.
Loading