Gusto

What’s supported

Supported actions

This connector supports:

• 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.
• Write Actions.
• Proxy Actions, using the base URL https://api.gusto.com.

Supported objects

The Gusto connector supports reading from the following objects:

• admins
• companies
• company_benefits
• contractor_payments
• contractors
• custom_fields
• departments
• earning_types
• employee_benefits
• employees
• garnishments
• home_addresses
• jobs
• locations
• pay_periods
• pay_schedules
• payrolls
• time_off_activities
• work_addresses

The Gusto connector supports writing to the following objects:

• admins
• companies
• company_benefits
• compensations
• contractor_payments
• contractors
• departments
• earning_types
• employee_benefits
• employees
• garnishments
• home_addresses
• jobs
• locations
• pay_periods
• pay_schedules
• payrolls
• work_addresses

Example integration

For an example manifest file of a Gusto integration, visit our samples repo on GitHub.

Before you get started

To connect Gusto with Ampersand, you will need a Gusto Developer Account.

Once your account is created, you’ll need to register an application in the Gusto Developer Portal and obtain the following credentials:

• Client ID
• Client Secret

You will then use these credentials to connect your application to Ampersand.

Creating a Gusto app

1. Log in to the Gusto Developer Portal.

2. Navigate to the Applications tab and click Create Application.

3. Enter the following details for your application:

   • Application Name: The name of your app.
   • Purpose: A description of your integration.

4. Under Redirect URIs, add: https://api.withampersand.com/callbacks/v1/oauth

5. Click Create. Note the Client ID and Client Secret. You will need these to connect your app to Ampersand.

For more details, see the Gusto Authentication documentation.

Add your Gusto app info to Ampersand

1. Log in to your Ampersand Dashboard.

2. Select the project where you want to create a Gusto integration.

   

3. Select Provider Apps.

4. Select Gusto from the Provider list.

5. Enter the Client ID and Client Secret obtained from your Gusto app.

6. Click Save Changes.

Using the connector

To start integrating with Gusto:

• Create a manifest file like the example above.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component. The UI component will prompt the customer for OAuth authorization.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Write Actions, you can start making API calls to our Write API.
  • If your integration has Proxy Actions, you can start making Proxy API calls.