Squarespace icon

Squarespace

Website builder and ecommerce for branded online presence.

6 triggers22 searches25 actionsPollingAuth: API keyAuth: OAuth

AI-assisted documentation21 min read

This documentation is compiled from our integration source code, internal specs for Squarespace, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Squarespace on WEXTL →

Before you set up the credential, make sure you have an active Squarespace account and an API access token from your account settings ready.[3]

Credential type option 1

Squarespace

  • Base URLtextRequired

    Base URL for the API. Enter: api.squarespace.com

    [1]
  • API KeypasswordRequired

    Generate this under Settings → Advanced → Developer API Keys on your site. The key is only shown once at creation.

    [1]
Credential type option 2

Squarespace

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

  • Client IDtext

    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.

    [1]
  • Client Secretpassword

    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.

    [1]
Integration requests 5 permissions:
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.
  1. Log in to your WEXTL account, add the Squarespace node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Squarespace account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch ContactsTrigger
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Localetext
Created Ondate
Primary Emailobject
Emailemail
Created Ondate
Accepts Marketingobject
Default Shipping Addressobject
IDtext
Default Shippingboolean
Addressobject
Watch OrdersTrigger
Output fields[3]
FieldType
IDtext
Order Numbertext
Created Ondate
Modified Ondate
Fulfillment Statustext
Payment Statetext
Channeltext
Channel Nametext
Customer Emailemail
Customer IDtext
External Order Referencetext
Price Tax Interpretationtext
Test Modeboolean
Shipping Option Nametext
Shipping Option Service Typetext
Fulfilled Ondate
Grand Totalobject
Valuenumber
Currencyobject
Subtotalobject
Valuenumber
Currencyobject
Tax Totalobject
Valuenumber
Currencyobject
Shipping Totalobject
Valuenumber
Currencyobject
10other output fields
Watch ProductsTrigger
Output fields[3]
FieldType
IDtext
Typetext
Nametext
Descriptiontext
URLurl
URL Slugtext
Is Visibleboolean
Store Page IDtext
Created Ondate
Modified Ondate
Tagsarray
Tagtext
Imagesarray
IDtext
URLurl
Alt Texttext
Order Indexnumber
SEO Optionsobject
Titletext
Descriptiontext
Watch ProfilesTrigger
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailemail
Created Ondate
Has Accountboolean
Is Customerboolean
Accepts Marketingboolean
Addressobject
First Nametext
Last Nametext
Address 1text
Address 2text
Citytext
Statetext
Postal Codetext
Country Codetext
Phonetext
Transactions Summaryobject
Order Countnumber
Donation Countnumber
First Order Submitted Ondate
Last Order Submitted Ondate
First Donation Submitted Ondate
Last Donation Submitted Ondate
Total Order Amountobject
Total Donation Amountobject
Total Refund Amountobject
Watch TransactionsTrigger
Output fields[3]
FieldType
IDtext
Sales Order IDtext
Created Ondate
Modified Ondate
Customer Emailemail
Voidedboolean
Payment Gateway Errortext
Totalobject
Valuenumber
Currencyobject
Total Net Paymentobject
Valuenumber
Currencyobject
Total Net Salesobject
Valuenumber
Currencyobject
Total Net Shippingobject
Valuenumber
Currencyobject
Total Salesobject
Valuenumber
Currencyobject
Total Taxesobject
Valuenumber
Currencyobject
Paymentsarray
IDtext
Providertext
Credit Card Typetext
External Transaction IDtext
External Customer IDtext
Gift Card IDtext
Paid Ondate
Amountobject
Net Amountobject
Refunded Amountobject
Sales Line Itemsarray
IDtext
Totalobject
Total Salesobject
Total Net Salesobject
Discount Amountobject
Taxesarray
Shipping Line Itemsarray
IDtext
Descriptiontext
Amountobject
Net Amountobject
Discount Amountobject
Taxesarray
Discountsarray
Nametext
Descriptiontext
Amountobject
Watch Webhook SubscriptionsTrigger
Output fields[3]
FieldType
IDtext
Client IDtext
Website IDtext
Endpoint URLurl
Created Ondate
Updated Ondate
Topicsarray
Topictext
Get Address BookSearch
Input fields[3]
FieldType
ContactRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Default Shippingboolean
Addressobject
First Nametext
Last Nametext
Line 1text
Line 2text
Citytext
Regiontext
Postal Codetext
Country Codetext
Phone Numbertext
Get Address Book EntryAction
Input fields[3]
FieldType
ContactRequired
choice
Output fields[3]
FieldType
IDtext
Default Shippingboolean
Addressobject
First Nametext
Last Nametext
Line 1text
Line 2text
Citytext
Regiontext
Postal Codetext
Country Codetext
Phone Numbertext
Get ContactAction
Input fields[3]
FieldType
ContactRequired
choice
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Localetext
Created Ondate
Primary Emailobject
Emailemail
Created Ondate
Accepts Marketingobject
Default Shipping Addressobject
IDtext
Default Shippingboolean
Addressobject
Get Image Processing StatusAction
Input fields[3]
FieldType
ProductRequired
choice
Output fields[3]
FieldType
Image IDtext
Statustext
Get InventoryAction
Input fields[3]
FieldType
Variant IDsRequired
choice
Output fields[3]
FieldType
Inventoryarray
Variant IDtext
SKUtext
Descriptortext
Quantitynumber
Is Unlimitedboolean
Get MemberAction
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailemail
Get OrderAction
Input fields[3]
FieldType
OrderRequired
choice
Output fields[3]
FieldType
IDtext
Order Numbertext
Created Ondate
Modified Ondate
Fulfillment Statustext
Payment Statetext
Channeltext
Channel Nametext
Customer Emailemail
Customer IDtext
External Order Referencetext
Price Tax Interpretationtext
Test Modeboolean
Shipping Option Nametext
Shipping Option Service Typetext
Fulfilled Ondate
Grand Totalobject
Valuenumber
Currencyobject
Subtotalobject
Valuenumber
Currencyobject
Tax Totalobject
Valuenumber
Currencyobject
Shipping Totalobject
Valuenumber
Currencyobject
10other output fields
Get ProductsAction
Input fields[3]
FieldType
Product IDsRequired
text
Output fields[3]
FieldType
Productsarray
IDtext
Typetext
Nametext
Descriptiontext
URLurl
URL Slugtext
Is Visibleboolean
Store Page IDtext
Created Ondate
Modified Ondate
Get ProfilesAction
Input fields[3]
FieldType
Profile IDsRequired
text
Output fields[3]
FieldType
Profilesarray
IDtext
First Nametext
Last Nametext
Emailemail
Created Ondate
Has Accountboolean
Is Customerboolean
Accepts Marketingboolean
Addressobject
Transactions Summaryobject
Get TransactionsAction
Input fields[3]
FieldType
Document IDsRequired
text
Output fields[3]
FieldType
Documentsarray
IDtext
Sales Order IDtext
Created Ondate
Modified Ondate
Customer Emailemail
Voidedboolean
Payment Gateway Errortext
Totalobject
Total Net Paymentobject
Total Net Salesobject
Get Webhook SubscriptionAction
Input fields[3]
FieldType
Webhook SubscriptionRequired
choice
Output fields[3]
FieldType
IDtext
Client IDtext
Website IDtext
Endpoint URLurl
Created Ondate
Updated Ondate
Topicsarray
Topictext
Get WebsiteAction
Output fields[3]
FieldType
IDtext
Site IDtext
Titletext
URLurl
Languagetext
Currencytext
Time Zonetext
Measurement Standardtext
Locationobject
Countrytext
Regiontext
List ContactsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Localetext
Created Ondate
Primary Emailobject
Emailemail
Created Ondate
Accepts Marketingobject
Default Shipping Addressobject
IDtext
Default Shippingboolean
Addressobject
List InventorySearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Variant IDtext
SKUtext
Descriptortext
Quantitynumber
Is Unlimitedboolean
List OrdersSearch
Input fields[3]
FieldType
Modified Aftertext
Modified Beforetext
Customer IDtext
Fulfillment Statuschoice
Payment Statestext
Limitnumber
Output fields[3]
FieldType
IDtext
Order Numbertext
Created Ondate
Modified Ondate
Fulfillment Statustext
Payment Statetext
Channeltext
Channel Nametext
Customer Emailemail
Customer IDtext
External Order Referencetext
Price Tax Interpretationtext
Test Modeboolean
Shipping Option Nametext
Shipping Option Service Typetext
Fulfilled Ondate
Grand Totalobject
Valuenumber
Currencyobject
Subtotalobject
Valuenumber
Currencyobject
Tax Totalobject
Valuenumber
Currencyobject
Shipping Totalobject
Valuenumber
Currencyobject
10other output fields
List ProductsSearch
Input fields[3]
FieldType
Modified Aftertext
Modified Beforetext
Search Querytext
Product Typesarray
Typechoice
Limitnumber
Output fields[3]
FieldType
IDtext
Typetext
Nametext
Descriptiontext
URLurl
URL Slugtext
Is Visibleboolean
Store Page IDtext
Created Ondate
Modified Ondate
Tagsarray
Tagtext
Imagesarray
IDtext
URLurl
Alt Texttext
Order Indexnumber
SEO Optionsobject
Titletext
Descriptiontext
List ProfilesSearch
Input fields[3]
FieldType
Emailemail
Filtertext
Sort Fieldchoice
Sort Directionchoice
Limitnumber
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailemail
Created Ondate
Has Accountboolean
Is Customerboolean
Accepts Marketingboolean
Addressobject
First Nametext
Last Nametext
Address 1text
Address 2text
Citytext
Statetext
Postal Codetext
Country Codetext
Phonetext
Transactions Summaryobject
Order Countnumber
Donation Countnumber
First Order Submitted Ondate
Last Order Submitted Ondate
First Donation Submitted Ondate
Last Donation Submitted Ondate
Total Order Amountobject
Total Donation Amountobject
Total Refund Amountobject
List Store PagesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Titletext
URL Slugtext
Is Enabledboolean
List TransactionsSearch
Input fields[3]
FieldType
Modified Aftertext
Modified Beforetext
Orderchoice
Limitnumber
Output fields[3]
FieldType
IDtext
Sales Order IDtext
Created Ondate
Modified Ondate
Customer Emailemail
Voidedboolean
Payment Gateway Errortext
Totalobject
Valuenumber
Currencyobject
Total Net Paymentobject
Valuenumber
Currencyobject
Total Net Salesobject
Valuenumber
Currencyobject
Total Net Shippingobject
Valuenumber
Currencyobject
Total Salesobject
Valuenumber
Currencyobject
Total Taxesobject
Valuenumber
Currencyobject
Paymentsarray
IDtext
Providertext
Credit Card Typetext
External Transaction IDtext
External Customer IDtext
Gift Card IDtext
Paid Ondate
Amountobject
Net Amountobject
Refunded Amountobject
Sales Line Itemsarray
IDtext
Totalobject
Total Salesobject
Total Net Salesobject
Discount Amountobject
Taxesarray
Shipping Line Itemsarray
IDtext
Descriptiontext
Amountobject
Net Amountobject
Discount Amountobject
Taxesarray
Discountsarray
Nametext
Descriptiontext
Amountobject
List Webhook SubscriptionsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Client IDtext
Website IDtext
Endpoint URLurl
Created Ondate
Updated Ondate
Topicsarray
Topictext
Query ContactsSearch
Input fields[3]
FieldType
Search Stringtext
Sort Fieldchoice
Sort Directionchoice
Accepts Marketing Filterobject
Accepts Marketingboolean
Joined Onobject
First Order Onobject
Aftertext
Beforetext
Last Order Onobject
Aftertext
Beforetext
Order Count Rangeobject
Minnumber
Maxnumber
Order Amount Rangeobject
Minnumber
Maxnumber
First Donation Onobject
Aftertext
Beforetext
Last Donation Onobject
Aftertext
Beforetext
Donation Count Rangeobject
Minnumber
Maxnumber
Donation Amount Rangeobject
Minnumber
Maxnumber
Limitnumber
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Localetext
Created Ondate
Primary Emailobject
Emailemail
Created Ondate
Accepts Marketingobject
Default Shipping Addressobject
IDtext
Default Shippingboolean
Addressobject
Retrieve Transaction SummariesSearch
Input fields[3]
FieldType
Contact IDsRequired
array
Contact IDchoice
Group ByRequired
choice
Limitnumber
Output fields[3]
FieldType
Contact IDtext
Transactions Summaryobject
Order Countnumber
Donation Countnumber
First Order Submitted Ondate
Last Order Submitted Ondate
First Donation Submitted Ondate
Last Donation Submitted Ondate
Total Order Amountobject
Total Donation Amountobject
Total Refund Amountobject
Adjust InventoryAction
Input fields[3]
FieldType
Idempotency KeyRequired
secret
Increment Operationsarray
Variantchoice
Quantitynumber
Decrement Operationsarray
Variantchoice
Quantitynumber
Set Finite Operationsarray
Variantchoice
Quantitynumber
Set Unlimited Operationsarray
Variant IDchoice
Associate Variant ImageAction
Input fields[3]
FieldType
ProductRequired
choice
ImageRequired
choice
Create Address Book EntryAction
Input fields[3]
FieldType
ContactRequired
choice
AddressRequired
object
First Nametext
Last Nametext
Line 1text
Line 2text
Citytext
Regiontext
Postal Codetext
Country CodeRequired
choice
Phone Numbertext
Default Shippingboolean
Create ContactAction
Input fields[3]
FieldType
First NameRequired
text
Last NameRequired
text
LocaleRequired
text
Primary EmailRequired
email
Accepts Marketingboolean
Create OrderAction
Input fields[3]
FieldType
Idempotency KeyRequired
text
Channel NameRequired
text
Created OnRequired
date
External Order ReferenceRequired
text
Price Tax InterpretationRequired
choice
Grand TotalRequired
object
Valuenumber
Currencyobject
Line ItemsRequired
array
Line Item TypeRequired
choice
QuantityRequired
number
Unit Price PaidRequired
object
Variantchoice
Titletext
Non-Sale Unit Priceobject
FulfillmentsRequired
array
Carrier NameRequired
text
ServiceRequired
text
Tracking NumberRequired
text
Ship DateRequired
text
Tracking URLurl
Customer Emailemail
Billing Addressobject
First Nametext
Last Nametext
Address 1text
Address 2text
Citytext
Statetext
Postal Codetext
Country Codetext
Phonetext
Shipping Addressobject
First Nametext
Last Nametext
Address 1text
Address 2text
Citytext
Statetext
Postal Codetext
Country Codetext
Phonetext
Fulfillment Statuschoice
Fulfilled Ontext
Inventory Behaviorchoice
Shopper Fulfillment Notificationchoice
Discount Linesarray
Nametext
Promo Codetext
Amountobject
Discount Totalobject
Valuenumber
Currencyobject
Shipping Linesarray
MethodRequired
text
AmountRequired
object
Shipping Totalobject
Valuenumber
Currencyobject
Subtotalobject
Valuenumber
Currencyobject
1other input field
Create ProductAction
Input fields[3]
FieldType
Store PageRequired
choice
Product TypeRequired
choice
Nametext
Descriptiontext
Is Visibleboolean
URL Slugtext
Tagsarray
Tagtext
Variant Attributesarray
Attribute Nametext
VariantsRequired
array
SKURequired
text
PricingRequired
object
Attributesobject
Stockobject
Shipping Measurementsobject
Create Product VariantAction
Input fields[3]
FieldType
ProductRequired
choice
SKURequired
text
PricingRequired
object
Base PriceRequired
object
On Saleboolean
Sale Priceobject
Attributesobject
Stockobject
Quantitynumber
Unlimitedboolean
Shipping Measurementsobject
Weightobject
Dimensionsobject
Create Webhook SubscriptionAction
Input fields[3]
FieldType
Endpoint URLRequired
url
Topicsarray
Topicchoice
Delete Address Book EntryAction
Input fields[3]
FieldType
ContactRequired
choice
Delete ContactAction
Input fields[3]
FieldType
ContactRequired
choice
Delete ProductAction
Input fields[3]
FieldType
ProductRequired
choice
Delete Product ImageAction
Input fields[3]
FieldType
ProductRequired
choice
Delete Product VariantAction
Input fields[3]
FieldType
ProductRequired
choice
Delete Webhook SubscriptionAction
Input fields[3]
FieldType
Webhook SubscriptionRequired
choice
Fulfill OrderAction
Input fields[3]
FieldType
OrderRequired
choice
Shipmentsarray
Carrier NameRequired
text
ServiceRequired
text
Tracking NumberRequired
text
Ship DateRequired
text
Tracking URLurl
Send Customer Notificationboolean
Replace Address Book EntryAction
Input fields[3]
FieldType
ContactRequired
choice
AddressRequired
object
First Nametext
Last Nametext
Line 1text
Line 2text
Citytext
Regiontext
Postal Codetext
Country CodeRequired
choice
Phone Numbertext
Default Shippingboolean
Output fields[3]
FieldType
IDtext
Default Shippingboolean
Addressobject
First Nametext
Last Nametext
Line 1text
Line 2text
Citytext
Regiontext
Postal Codetext
Country Codetext
Phone Numbertext
Rotate Webhook SecretAction
Input fields[3]
FieldType
Webhook SubscriptionRequired
choice
Output fields[3]
FieldType
Secrettext
Send Test NotificationAction
Input fields[3]
FieldType
Webhook SubscriptionRequired
choice
TopicRequired
text
Output fields[3]
FieldType
Status Codenumber
Update ContactAction
Input fields[3]
FieldType
ContactRequired
choice
First Nametext
Last Nametext
Localetext
Primary Email Addressemail
Primary Email Accepts Marketingboolean
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Localetext
Created Ondate
Primary Emailobject
Emailemail
Created Ondate
Accepts Marketingobject
Default Shipping Addressobject
IDtext
Default Shippingboolean
Addressobject
Update ProductAction
Input fields[3]
FieldType
ProductRequired
choice
Nameobject
Presentboolean
Valuetext
Descriptionobject
Presentboolean
Valuetext
Is Visibleobject
Presentboolean
Valueboolean
URL Slugobject
Presentboolean
Valuetext
Tagsobject
Presentboolean
Valuesarray
Product Attribute Namesobject
Presentboolean
Valuesarray
SEO Dataobject
Presentboolean
SEO Optionsobject
Pricingobject
Presentboolean
Pricing Valuesobject
Output fields[3]
FieldType
IDtext
Typetext
Nametext
Descriptiontext
URLurl
URL Slugtext
Is Visibleboolean
Store Page IDtext
Created Ondate
Modified Ondate
Tagsarray
Tagtext
Imagesarray
IDtext
URLurl
Alt Texttext
Order Indexnumber
SEO Optionsobject
Titletext
Descriptiontext
Update Product ImageAction
Input fields[3]
FieldType
ProductRequired
choice
Alt Textobject
Presentboolean
Valuetext
Output fields[3]
FieldType
IDtext
URLurl
Alt Texttext
Order Indexnumber
Original Sizeobject
Available Formatsarray
Formattext
Update Product Image OrderAction
Input fields[3]
FieldType
ProductRequired
choice
After Image IDobject
Presentboolean
Image IDtext
Update Product VariantAction
Input fields[3]
FieldType
ProductRequired
choice
SKUobject
Presentboolean
Valuetext
Attributesobject
Presentboolean
Attribute Valuesobject
Pricingobject
Presentboolean
Pricing Valuesobject
Shipping Measurementsobject
Presentboolean
Measurementsobject
Output fields[3]
FieldType
IDtext
SKUtext
Imageobject
IDtext
URLurl
Alt Texttext
Order Indexnumber
Original Sizeobject
Available Formatsarray
Update Webhook SubscriptionAction
Input fields[3]
FieldType
Webhook SubscriptionRequired
choice
Endpoint URLobject
Presentboolean
Valueurl
Topicsobject
Presentboolean
Valuesarray
Output fields[3]
FieldType
IDtext
Client IDtext
Website IDtext
Endpoint URLurl
Created Ondate
Updated Ondate
Topicsarray
Topictext
Upload Product ImageAction
Input fields[3]
FieldType
ProductRequired
choice
Image FileRequired
text
Filenametext

Look for Squarespace templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Squarespace Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Squarespace.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 22, 2026 23:19