About this integration
Website builder and ecommerce for branded online presence. This integration exposes its full API as workflow modules.
The integration includes 6 triggers, 22 search modules and 25 actions. Connections use basic or oauth authentication.
How to connect
The credential form asks for Base URL, API Key, Client ID, and Client Secret.
OAuth asks you to approve Send order data and mark orders as fulfilled., Access transactional order and donation data., and View and update inventory stock levels. before access is granted.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
Base URLRequired | text | Base URL for the API. Enter: api.squarespace.com |
API KeyRequired | password | Generate this under Settings → Advanced → Developer API Keys on your site. The key is only shown once at creation. |
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
Client ID | text | Leave blank to use the default app-wide Client ID, or enter your own if you registered a custom OAuth client with Squarespace. To get one: submit your client details (name, icon, redirect URI, initiate URL, terms & privacy policy links) via Squarespace's developer OAuth client registration form. Squarespace will review and email you a Client ID and Client Secret. |
Client Secret | password | Leave blank to use the default app-wide Client Secret, or enter your own if you registered a custom OAuth client with Squarespace. This is issued alongside your Client ID after Squarespace approves your OAuth client registration request — see the Client ID field above for how to register. |
- Send order data and mark orders as fulfilled.
- Access transactional order and donation data.
- View and update inventory stock levels.
- View product information and modify products.
- View customer contact information and address book entries; create, update, and delete contacts and address book entries.
Use it in workflow automation
Start with Watch Contacts, then add Adjust Inventory.
The canvas below runs Watch Contacts into Adjust Inventory — watch the video, then drop a node onto the canvas.
Select the Watch Products trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create Product Variant as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 31 ready-made modules for marketing work — each run logs its inputs and outputs for debugging.
Squarespace workflow on the canvas: Watch Products then Create Product Variant
Triggers, searches and actions
Browse every Squarespace module field below: 6 triggers, 22 searchs, and 25 actions you can drop onto the canvas.
Triggers
This integration includes 6 triggers — start a workflow the moment something changes in the app.
- Watch Contacts
- Watch Orders
- Watch Products
- Watch Profiles
- Watch Transactions
Searches
Use any of 22 search modules to retrieve records without leaving the workflow canvas.
- Get Address Book
- Get Address Book Entry
- Get Contact
- Get Image Processing Status
- Get Inventory
Actions
This integration includes 25 action modules — create, update, or delete records as part of any workflow.
- Adjust Inventory
- Associate Variant Image
- Create Address Book Entry
- Create Contact
- Create Order
Explore the fields available for each Squarespace trigger, search, and action.
Triggers
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Locale | text |
Created On | date |
Primary Email | object |
Email | |
Created On | date |
Accepts Marketing | object |
Default Shipping Address | object |
ID | text |
Default Shipping | boolean |
Address | object |
| Field | Type |
|---|---|
ID | text |
Order Number | text |
Created On | date |
Modified On | date |
Fulfillment Status | text |
Payment State | text |
Channel | text |
Channel Name | text |
Customer Email | |
Customer ID | text |
External Order Reference | text |
Price Tax Interpretation | text |
Test Mode | boolean |
Shipping Option Name | text |
Shipping Option Service Type | text |
Fulfilled On | date |
Grand Total | object |
Value | number |
Currency | object |
Subtotal | object |
Value | number |
Currency | object |
Tax Total | object |
Value | number |
Currency | object |
Shipping Total | object |
Value | number |
Currency | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Description | text |
URL | url |
URL Slug | text |
Is Visible | boolean |
Store Page ID | text |
Created On | date |
Modified On | date |
Tags | array |
Tag | text |
Images | array |
ID | text |
URL | url |
Alt Text | text |
Order Index | number |
SEO Options | object |
Title | text |
Description | text |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | |
Created On | date |
Has Account | boolean |
Is Customer | boolean |
Accepts Marketing | boolean |
Address | object |
First Name | text |
Last Name | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postal Code | text |
Country Code | text |
Phone | text |
Transactions Summary | object |
Order Count | number |
Donation Count | number |
First Order Submitted On | date |
Last Order Submitted On | date |
First Donation Submitted On | date |
Last Donation Submitted On | date |
Total Order Amount | object |
Total Donation Amount | object |
Total Refund Amount | object |
| Field | Type |
|---|---|
ID | text |
Sales Order ID | text |
Created On | date |
Modified On | date |
Customer Email | |
Voided | boolean |
Payment Gateway Error | text |
Total | object |
Value | number |
Currency | object |
Total Net Payment | object |
Value | number |
Currency | object |
Total Net Sales | object |
Value | number |
Currency | object |
Total Net Shipping | object |
Value | number |
Currency | object |
Total Sales | object |
Value | number |
Currency | object |
Total Taxes | object |
Value | number |
Currency | object |
Payments | array |
ID | text |
Provider | text |
Credit Card Type | text |
External Transaction ID | text |
External Customer ID | text |
Gift Card ID | text |
Paid On | date |
Amount | object |
Net Amount | object |
Refunded Amount | object |
Sales Line Items | array |
ID | text |
Total | object |
Total Sales | object |
Total Net Sales | object |
Discount Amount | object |
Taxes | array |
Shipping Line Items | array |
ID | text |
Description | text |
Amount | object |
Net Amount | object |
Discount Amount | object |
Taxes | array |
Discounts | array |
Name | text |
Description | text |
Amount | object |
| Field | Type |
|---|---|
ID | text |
Client ID | text |
Website ID | text |
Endpoint URL | url |
Created On | date |
Updated On | date |
Topics | array |
Topic | text |
Searches
| Field | Type |
|---|---|
ContactRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Default Shipping | boolean |
Address | object |
First Name | text |
Last Name | text |
Line 1 | text |
Line 2 | text |
City | text |
Region | text |
Postal Code | text |
Country Code | text |
Phone Number | text |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
ID | text |
Default Shipping | boolean |
Address | object |
First Name | text |
Last Name | text |
Line 1 | text |
Line 2 | text |
City | text |
Region | text |
Postal Code | text |
Country Code | text |
Phone Number | text |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Locale | text |
Created On | date |
Primary Email | object |
Email | |
Created On | date |
Accepts Marketing | object |
Default Shipping Address | object |
ID | text |
Default Shipping | boolean |
Address | object |
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
Image ID | text |
Status | text |
| Field | Type |
|---|---|
Variant IDsRequired | choice |
| Field | Type |
|---|---|
Inventory | array |
Variant ID | text |
SKU | text |
Descriptor | text |
Quantity | number |
Is Unlimited | boolean |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email |
| Field | Type |
|---|---|
OrderRequired | choice |
| Field | Type |
|---|---|
ID | text |
Order Number | text |
Created On | date |
Modified On | date |
Fulfillment Status | text |
Payment State | text |
Channel | text |
Channel Name | text |
Customer Email | |
Customer ID | text |
External Order Reference | text |
Price Tax Interpretation | text |
Test Mode | boolean |
Shipping Option Name | text |
Shipping Option Service Type | text |
Fulfilled On | date |
Grand Total | object |
Value | number |
Currency | object |
Subtotal | object |
Value | number |
Currency | object |
Tax Total | object |
Value | number |
Currency | object |
Shipping Total | object |
Value | number |
Currency | object |
| Field | Type |
|---|---|
Product IDsRequired | text |
| Field | Type |
|---|---|
Products | array |
ID | text |
Type | text |
Name | text |
Description | text |
URL | url |
URL Slug | text |
Is Visible | boolean |
Store Page ID | text |
Created On | date |
Modified On | date |
| Field | Type |
|---|---|
Profile IDsRequired | text |
| Field | Type |
|---|---|
Profiles | array |
ID | text |
First Name | text |
Last Name | text |
Email | |
Created On | date |
Has Account | boolean |
Is Customer | boolean |
Accepts Marketing | boolean |
Address | object |
Transactions Summary | object |
| Field | Type |
|---|---|
Document IDsRequired | text |
| Field | Type |
|---|---|
Documents | array |
ID | text |
Sales Order ID | text |
Created On | date |
Modified On | date |
Customer Email | |
Voided | boolean |
Payment Gateway Error | text |
Total | object |
Total Net Payment | object |
Total Net Sales | object |
| Field | Type |
|---|---|
Webhook SubscriptionRequired | choice |
| Field | Type |
|---|---|
ID | text |
Client ID | text |
Website ID | text |
Endpoint URL | url |
Created On | date |
Updated On | date |
Topics | array |
Topic | text |
| Field | Type |
|---|---|
ID | text |
Site ID | text |
Title | text |
URL | url |
Language | text |
Currency | text |
Time Zone | text |
Measurement Standard | text |
Location | object |
Country | text |
Region | text |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Locale | text |
Created On | date |
Primary Email | object |
Email | |
Created On | date |
Accepts Marketing | object |
Default Shipping Address | object |
ID | text |
Default Shipping | boolean |
Address | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Variant ID | text |
SKU | text |
Descriptor | text |
Quantity | number |
Is Unlimited | boolean |
| Field | Type |
|---|---|
Modified After | text |
Modified Before | text |
Customer ID | text |
Fulfillment Status | choice |
Payment States | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Order Number | text |
Created On | date |
Modified On | date |
Fulfillment Status | text |
Payment State | text |
Channel | text |
Channel Name | text |
Customer Email | |
Customer ID | text |
External Order Reference | text |
Price Tax Interpretation | text |
Test Mode | boolean |
Shipping Option Name | text |
Shipping Option Service Type | text |
Fulfilled On | date |
Grand Total | object |
Value | number |
Currency | object |
Subtotal | object |
Value | number |
Currency | object |
Tax Total | object |
Value | number |
Currency | object |
Shipping Total | object |
Value | number |
Currency | object |
| Field | Type |
|---|---|
Modified After | text |
Modified Before | text |
Search Query | text |
Product Types | array |
Type | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Description | text |
URL | url |
URL Slug | text |
Is Visible | boolean |
Store Page ID | text |
Created On | date |
Modified On | date |
Tags | array |
Tag | text |
Images | array |
ID | text |
URL | url |
Alt Text | text |
Order Index | number |
SEO Options | object |
Title | text |
Description | text |
| Field | Type |
|---|---|
Email | |
Filter | text |
Sort Field | choice |
Sort Direction | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Email | |
Created On | date |
Has Account | boolean |
Is Customer | boolean |
Accepts Marketing | boolean |
Address | object |
First Name | text |
Last Name | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postal Code | text |
Country Code | text |
Phone | text |
Transactions Summary | object |
Order Count | number |
Donation Count | number |
First Order Submitted On | date |
Last Order Submitted On | date |
First Donation Submitted On | date |
Last Donation Submitted On | date |
Total Order Amount | object |
Total Donation Amount | object |
Total Refund Amount | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Title | text |
URL Slug | text |
Is Enabled | boolean |
| Field | Type |
|---|---|
Modified After | text |
Modified Before | text |
Order | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Sales Order ID | text |
Created On | date |
Modified On | date |
Customer Email | |
Voided | boolean |
Payment Gateway Error | text |
Total | object |
Value | number |
Currency | object |
Total Net Payment | object |
Value | number |
Currency | object |
Total Net Sales | object |
Value | number |
Currency | object |
Total Net Shipping | object |
Value | number |
Currency | object |
Total Sales | object |
Value | number |
Currency | object |
Total Taxes | object |
Value | number |
Currency | object |
Payments | array |
ID | text |
Provider | text |
Credit Card Type | text |
External Transaction ID | text |
External Customer ID | text |
Gift Card ID | text |
Paid On | date |
Amount | object |
Net Amount | object |
Refunded Amount | object |
Sales Line Items | array |
ID | text |
Total | object |
Total Sales | object |
Total Net Sales | object |
Discount Amount | object |
Taxes | array |
Shipping Line Items | array |
ID | text |
Description | text |
Amount | object |
Net Amount | object |
Discount Amount | object |
Taxes | array |
Discounts | array |
Name | text |
Description | text |
Amount | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Client ID | text |
Website ID | text |
Endpoint URL | url |
Created On | date |
Updated On | date |
Topics | array |
Topic | text |
| Field | Type |
|---|---|
Search String | text |
Sort Field | choice |
Sort Direction | choice |
Accepts Marketing Filter | object |
Accepts Marketing | boolean |
Joined On | object |
First Order On | object |
After | text |
Before | text |
Last Order On | object |
After | text |
Before | text |
Order Count Range | object |
Min | number |
Max | number |
Order Amount Range | object |
Min | number |
Max | number |
First Donation On | object |
After | text |
Before | text |
Last Donation On | object |
After | text |
Before | text |
Donation Count Range | object |
Min | number |
Max | number |
Donation Amount Range | object |
Min | number |
Max | number |
Limit | number |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Locale | text |
Created On | date |
Primary Email | object |
Email | |
Created On | date |
Accepts Marketing | object |
Default Shipping Address | object |
ID | text |
Default Shipping | boolean |
Address | object |
| Field | Type |
|---|---|
Contact IDsRequired | array |
Contact ID | choice |
Group ByRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Contact ID | text |
Transactions Summary | object |
Order Count | number |
Donation Count | number |
First Order Submitted On | date |
Last Order Submitted On | date |
First Donation Submitted On | date |
Last Donation Submitted On | date |
Total Order Amount | object |
Total Donation Amount | object |
Total Refund Amount | object |
Actions
| Field | Type |
|---|---|
Idempotency KeyRequired | secret |
Increment Operations | array |
Variant | choice |
Quantity | number |
Decrement Operations | array |
Variant | choice |
Quantity | number |
Set Finite Operations | array |
Variant | choice |
Quantity | number |
Set Unlimited Operations | array |
Variant ID | choice |
| Field | Type |
|---|---|
ProductRequired | choice |
ImageRequired | choice |
| Field | Type |
|---|---|
ContactRequired | choice |
AddressRequired | object |
First Name | text |
Last Name | text |
Line 1 | text |
Line 2 | text |
City | text |
Region | text |
Postal Code | text |
Country CodeRequired | choice |
Phone Number | text |
Default Shipping | boolean |
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
LocaleRequired | text |
Primary EmailRequired | |
Accepts Marketing | boolean |
| Field | Type |
|---|---|
Idempotency KeyRequired | text |
Channel NameRequired | text |
Created OnRequired | date |
External Order ReferenceRequired | text |
Price Tax InterpretationRequired | choice |
Grand TotalRequired | object |
Value | number |
Currency | object |
Line ItemsRequired | array |
Line Item TypeRequired | choice |
QuantityRequired | number |
Unit Price PaidRequired | object |
Variant | choice |
Title | text |
Non-Sale Unit Price | object |
FulfillmentsRequired | array |
Carrier NameRequired | text |
ServiceRequired | text |
Tracking NumberRequired | text |
Ship DateRequired | text |
Tracking URL | url |
Customer Email | |
Billing Address | object |
First Name | text |
Last Name | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postal Code | text |
Country Code | text |
Phone | text |
Shipping Address | object |
First Name | text |
Last Name | text |
Address 1 | text |
Address 2 | text |
City | text |
State | text |
Postal Code | text |
Country Code | text |
Phone | text |
Fulfillment Status | choice |
Fulfilled On | text |
Inventory Behavior | choice |
Shopper Fulfillment Notification | choice |
Discount Lines | array |
Name | text |
Promo Code | text |
Amount | object |
Discount Total | object |
Value | number |
Currency | object |
Shipping Lines | array |
MethodRequired | text |
AmountRequired | object |
Shipping Total | object |
Value | number |
Currency | object |
Subtotal | object |
Value | number |
Currency | object |
| Field | Type |
|---|---|
Store PageRequired | choice |
Product TypeRequired | choice |
Name | text |
Description | text |
Is Visible | boolean |
URL Slug | text |
Tags | array |
Tag | text |
Variant Attributes | array |
Attribute Name | text |
VariantsRequired | array |
SKURequired | text |
PricingRequired | object |
Attributes | object |
Stock | object |
Shipping Measurements | object |
| Field | Type |
|---|---|
ProductRequired | choice |
SKURequired | text |
PricingRequired | object |
Base PriceRequired | object |
On Sale | boolean |
Sale Price | object |
Attributes | object |
Stock | object |
Quantity | number |
Unlimited | boolean |
Shipping Measurements | object |
Weight | object |
Dimensions | object |
| Field | Type |
|---|---|
Endpoint URLRequired | url |
Topics | array |
Topic | choice |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
ProductRequired | choice |
| Field | Type |
|---|---|
Webhook SubscriptionRequired | choice |
| Field | Type |
|---|---|
OrderRequired | choice |
Shipments | array |
Carrier NameRequired | text |
ServiceRequired | text |
Tracking NumberRequired | text |
Ship DateRequired | text |
Tracking URL | url |
Send Customer Notification | boolean |
| Field | Type |
|---|---|
ContactRequired | choice |
AddressRequired | object |
First Name | text |
Last Name | text |
Line 1 | text |
Line 2 | text |
City | text |
Region | text |
Postal Code | text |
Country CodeRequired | choice |
Phone Number | text |
Default Shipping | boolean |
| Field | Type |
|---|---|
ID | text |
Default Shipping | boolean |
Address | object |
First Name | text |
Last Name | text |
Line 1 | text |
Line 2 | text |
City | text |
Region | text |
Postal Code | text |
Country Code | text |
Phone Number | text |
| Field | Type |
|---|---|
Webhook SubscriptionRequired | choice |
| Field | Type |
|---|---|
Secret | text |
| Field | Type |
|---|---|
Webhook SubscriptionRequired | choice |
TopicRequired | text |
| Field | Type |
|---|---|
Status Code | number |
| Field | Type |
|---|---|
ContactRequired | choice |
First Name | text |
Last Name | text |
Locale | text |
Primary Email Address | |
Primary Email Accepts Marketing | boolean |
| Field | Type |
|---|---|
ID | text |
First Name | text |
Last Name | text |
Locale | text |
Created On | date |
Primary Email | object |
Email | |
Created On | date |
Accepts Marketing | object |
Default Shipping Address | object |
ID | text |
Default Shipping | boolean |
Address | object |
| Field | Type |
|---|---|
ProductRequired | choice |
Name | object |
Present | boolean |
Value | text |
Description | object |
Present | boolean |
Value | text |
Is Visible | object |
Present | boolean |
Value | boolean |
URL Slug | object |
Present | boolean |
Value | text |
Tags | object |
Present | boolean |
Values | array |
Product Attribute Names | object |
Present | boolean |
Values | array |
SEO Data | object |
Present | boolean |
SEO Options | object |
Pricing | object |
Present | boolean |
Pricing Values | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Name | text |
Description | text |
URL | url |
URL Slug | text |
Is Visible | boolean |
Store Page ID | text |
Created On | date |
Modified On | date |
Tags | array |
Tag | text |
Images | array |
ID | text |
URL | url |
Alt Text | text |
Order Index | number |
SEO Options | object |
Title | text |
Description | text |
| Field | Type |
|---|---|
ProductRequired | choice |
Alt Text | object |
Present | boolean |
Value | text |
| Field | Type |
|---|---|
ID | text |
URL | url |
Alt Text | text |
Order Index | number |
Original Size | object |
Available Formats | array |
Format | text |
| Field | Type |
|---|---|
ProductRequired | choice |
After Image ID | object |
Present | boolean |
Image ID | text |
| Field | Type |
|---|---|
ProductRequired | choice |
SKU | object |
Present | boolean |
Value | text |
Attributes | object |
Present | boolean |
Attribute Values | object |
Pricing | object |
Present | boolean |
Pricing Values | object |
Shipping Measurements | object |
Present | boolean |
Measurements | object |
| Field | Type |
|---|---|
ID | text |
SKU | text |
Image | object |
ID | text |
URL | url |
Alt Text | text |
Order Index | number |
Original Size | object |
Available Formats | array |
| Field | Type |
|---|---|
Webhook SubscriptionRequired | choice |
Endpoint URL | object |
Present | boolean |
Value | url |
Topics | object |
Present | boolean |
Values | array |
| Field | Type |
|---|---|
ID | text |
Client ID | text |
Website ID | text |
Endpoint URL | url |
Created On | date |
Updated On | date |
Topics | array |
Topic | text |
| Field | Type |
|---|---|
ProductRequired | choice |
Image FileRequired | text |
Filename | text |

