The Square connector is a Palantir-provided driver for Square.
To create a new Square source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Square-specific configuration and networking. For the complete property reference, see the official Square driver documentation ↗.
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
InitiateOAuth ↗ | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
LocationId ↗ | Recommended | The Id of a business location that will be set as default. | — |
OAuthClientId ↗ | Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
OAuthClientSecret ↗ | Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
Schema ↗ | Recommended | Specify the Square server version to connect with. | v1 |
UseSandbox ↗ | Recommended | A boolean indicating whether you are using a Sandbox account. The provider makes requests to the production environment by default. | FALSE |
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| connect.squareup.com | If UseSandbox=FALSE (default) |
| connect.squareupsandbox.com | If UseSandbox=TRUE |