What’s supported
Supported actions
This connector supports:- Read Actions, including full historic backfill. Please note that incremental read is supported only for
gift_cards/activities,payments,payoutsandrefundscurrently. For all other objects, a full read of the Square instance will be done per scheduled read. - Write Actions.
- Proxy Actions, using the base URL
https://connect.squareup.com.
Supported objects
The Square connector supports reading from and writing to the following objects:Read objects
- bank_accounts
- bookings
- bookings/custom_attribute_definitions
- bookings/location_booking_profiles
- bookings/team_member_booking_profiles
- cards
- catalog
- channels
- customers
- customers/custom_attribute_definitions
- customers/groups
- customers/segments
- devices
- devices/codes
- disputes
- events/types
- gift_cards
- gift_cards/activities
- labor/break_types
- labor/team_member_wages
- labor/workweek_configs
- locations
- locations/custom_attribute_definitions
- loyalty/programs
- merchants
- merchants/custom_attribute_definitions
- online_checkout/payment_links
- orders/custom_attribute_definitions
- payments
- payouts
- refunds
- sites
- team_members/jobs
- webhooks/event_types
- webhooks/subscriptions
Write objects
- bookings
- bookings/custom_attribute_definitions
- cards
- catalog
- customers
- customers/custom_attribute_definitions
- customers/groups
- devices/codes
- gift_cards
- gift_cards/activities
- labor/break_types
- labor/workweek_configs
- locations
- locations/custom_attribute_definitions
- merchants/custom_attribute_definitions
- online_checkout/payment_links
- orders/custom_attribute_definitions
- payments
- refunds
- team_members/jobs
- webhooks/subscriptions
Example integration
For an example manifest file of a Square integration, visit our samples repo on GitHub.For testing against Square’s sandbox environment, set
provider: squareSandbox in your manifest file. This is identical to square except that it uses the base URL https://connect.squareupsandbox.com.Before you get started
To integrate Square with Ampersand, you will need a Square account. Once your account is created, you’ll need to create a Square app and obtain the following credentials from it:- Client ID
- Client Secret
Creating a Square app
- Log in to the Square developer portal.
- Click + to create a new application and give it a name.
- Open the application and select the OAuth tab.
-
Set the redirect/callback URL to:
https://api.withampersand.com/callbacks/v1/oauth - Copy the Application ID (Client ID) and Application Secret (Client Secret) from the OAuth page.
-
Note the OAuth permissions (scopes) your integration requires.
Add your Square app info to Ampersand
- Log in to your Ampersand Dashboard.
-
Select the project where you want to create a Square integration.
- Select Provider Apps.
- Select Square from the Provider list.
- Enter the Client ID and Client Secret obtained from your Square app.
- Enter the scopes your integration requires.
- Click Save Changes.
Using the connector
To start integrating with Square:- 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.