Square component

The Square Component is designed to facilitate interaction with the Square API.

---

Description

The Square Component is designed to facilitate interaction with the Square API.

This component has been tested with API version 2024-06-04.

Credentials

To use this component, you will need to obtain a personal access token.

Component credentials configuration fields:

• Access token (string, required): Provide your Sandbox or Production access token here.
• Environment (dropdown, required): Select the desired environment.
• Square Version (string, optional): Specify the version here. If left blank, the component will default to 2024-06-04.

Triggers

Webhook

Creates a subscription in Square for selected events and receives them.

Configuration Fields

• Events - (multiselect dropdown, required): Select the events to subscribe to.
• Name of the Webhook - (string, optional): Specify a name for your webhook. This can help you identify it in the Square UI. If not provided, the name will default to “Flow {flow_id}”.
• API version - (string, required): The Square API version that will be used to send events to the component. If left blank, the component will use the version specified in the credentials or default to 2024-06-04.

Input Metadata

None

Output Metadata

The selected event from the subscription.

Limitations

• If you use an ordinary flow (real-time not enabled), after the flow starts, you will need to run it once. Just follow the webhook URL (to trigger the first execution). This action will create a subscription.

Actions

Make Raw Request

Executes a custom request.

Configuration Fields

• Don’t throw error on 404 Response - (optional, boolean): Treat 404 HTTP responses as non-errors. Defaults to false.

Input Metadata

• Url - (string, required): The relative path of the resource, appended to the base URL https://connect.squareup.com/v2/ (or https://connect.squareupsandbox.com/v2/ for Sandbox).
• Method - (string, required): The HTTP verb to use in the request, one of GET, POST, PUT, PATCH, DELETE.
• Request Body - (object, optional): The body of the request to send.

Output Metadata

• Status Code - (number, required): The HTTP status code of the response.
• HTTP Headers - (object, required): The HTTP headers of the response.
• Response Body - (object, optional): The HTTP response body.