CONNECT APP
Build with Square
Commerce
- OAuth
MCP
Give your agent Square tools
Every Square action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Square account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "square",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Customer:
const result = await mcp.callTool({
name: "square-create-customer",
arguments: {
givenName: "Given Name",
familyName: "Family Name",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "square",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create Customer:
result = await session.call_tool("square-create-customer", {
"givenName": "Given Name",
"familyName": "Family Name",
})API PROXY
Call the Square API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Square API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://connect.squareup.com/oauth2/token/status",
})
// Any allowed Square endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://connect.squareup.com/oauth2/token/status
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9jb25uZWN0LnNxdWFyZXVwLmNvbS9vYXV0aDIvdG9rZW4vc3RhdHVz?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Square actions from your backend
Connect a user's Square account once, then run Create Customer on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "square-create-customer",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
square: { authProvisionId: "apn_xxxxxxx" },
givenName: "Given Name",
familyName: "Family Name",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="square-create-customer",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"square": {"authProvisionId": "apn_xxxxxxx"},
"givenName": "Given Name",
"familyName": "Family Name",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "square-create-customer",
"configured_props": {
"square": { "authProvisionId": "apn_xxxxxxx" },
"givenName": "Given Name",
"familyName": "Family Name"
}
}'TOOLS
Square actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Customer
actionCreates a new customer for a business. Must provide at least one of the following: Given Name, Family Name, Company Name, Email Address, or Phone Number. See the docs.Writev0.0.5 -
Create Invoice
actionCreates a draft invoice for an order. You must send (publish) the invoice before Square can process it. See the documentation.Writev0.0.6 -
Create Order
actionCreates a new order that can include information about products for purchase. See docs here.Writev0.0.4 -
List Location Options
actionRetrieves available options for the Location field.Read-onlyv0.0.1 -
List Webhook Event Types Options
actionRetrieves available options for the Webhook Event Types field.Read-onlyv0.0.1 -
Send Invoice
actionPublishes the latest version of a specified invoice. See the docs.Writev0.0.4
-
Catalog Item Updated
triggerEmit new event every time a catalog item is updated. See the docsv0.0.3 -
New Booking Created
triggerEmit new event for every new booking created. See the docsv0.0.3 -
New Customer Created
triggerEmit new event for every new customer created. See the docsv0.0.3 -
New Invoice Created
triggerEmit new event for every new invoice created. See the docsv0.0.3 -
New Order Created
triggerEmit new event for every new order created. See the docsv0.0.3
MULTI-APP
Use Square with other popular apps
Most products don't stop at one integration. Pair Square with the other apps your users rely on, and ship use cases that span both.
- App slug
- square
- Authentication
- OAuth
- Categories
- Commerce
- Actions
- 6
- Triggers
- 5
- API proxy
- Available
OAuth scopes
These are the scopes Pipedream's managed Square OAuth client requests when one of your users connects an account. Supply your own OAuth client to request a different set.
- CUSTOMERS_READ
- CUSTOMERS_WRITE
- PAYMENTS_READ
- PAYMENTS_WRITE
- ORDERS_READ
- ORDERS_WRITE
- SUBSCRIPTIONS_READ
- SUBSCRIPTIONS_WRITE
- ITEMS_READ
- ITEMS_WRITE
- INVOICES_READ
- INVOICES_WRITE
- LOYALTY_READ
- LOYALTY_WRITE
- EMPLOYEES_READ
- EMPLOYEES_WRITE
- MERCHANT_PROFILE_READ
- BANK_ACCOUNTS_READ
- SETTLEMENTS_READ
- DEVELOPER_APPLICATION_WEBHOOKS_WRITE
- APPOINTMENTS_ALL_READ
- APPOINTMENTS_READ