Before you start
Ticks are kept in this browser only.
Follow the path that matches your account. Provider screenshots come from the linked official documentation and may show a different theme or older navigation. Configuration examples are labelled separately.
Permissions to choose
Use these exact permission names. Conditional permissions are needed only for the features described.
| Permission / scope | When needed | What it allows |
|---|---|---|
API key: Orders → Read Only | Required | Reads orders, fulfilments and the customer information included in an order. |
API key: Transactions → Read Only | Required | Reads the payment and refund transaction records associated with orders. |
OAuth: website.orders.read | Required | The order and fulfilment scope requested by Revient's OAuth flow. |
OAuth: website.transactions.read | Required | The transaction scope requested by Revient's OAuth flow. |
OAuth: access_type=offline | Required | Requests refresh capability for continued syncing. This is an authorisation parameter, not another scope. |
Webhook subscriptions | Conditional | Requires an OAuth token and permissions for the subscribed event types. Revient subscribes to order.create, order.update and extension.uninstall.An API key cannot enable this capability. Webhook setup registers a subscription; it does not grant permission to change orders. |
Order write, Inventory, Products, Forms and Contacts access | Not requested | Not needed by the current Revient connection. Leave unrelated API-key permissions unselected. |
Use the API-key permission labels for a key connection, or the two exact OAuth scopes for the OAuth connection. Neither path requests the website.orders write scope.
Option 1: connect with a Commerce API key
Suitable for merchant testing when the site's plan exposes both required APIs.
Open your site's API-key settings
Squarespace site → Settings → Developer tools → Developer API Keys
- Check the site name before generating a key; a key belongs to one site.
- Open Developer API Keys and choose Generate Key. Older site navigation may place this under Settings → Advanced.
- If Orders or Transactions is unavailable, check plan eligibility with your site owner. Use CSV import while access is unresolved.
You should seeThe key creation screen offers both Orders and Transactions permissions.Create a dedicated key with the two read permissions
Squarespace → Generate Key
- Name the key Revient (read only).
- Select Orders and Transactions, with Read Only for each. Leave unrelated APIs unchecked.
- Continue with Next and copy the generated key into your secure credential manager before closing the window.
You should seeYou have the new key; its secret is not retrievable after closing the generated-key screen.Paste the key into Revient
Revient → Integrations → Squarespace → Connect
- Paste the dedicated key into Commerce API key and select Connect Squarespace.
- Revient checks the site's identity and order read access. Verify that the resulting connection is the site you intended.
- Do not paste an OAuth application client secret into the API-key field; these are different credential types.
You should seeThe intended site appears in Manage. API-key connections use syncing without Squarespace webhook controls.Sync and compare a source order
Revient → selected Squarespace store → Manage
- Run Check connection, then Sync now. Open the intake queue to see the job and imported records.
- Compare a known order's number, source ID, currency, total, refund total and fulfilment date. Check transaction access separately if payment references are unavailable.
- Upload real dispute facts from the payment provider separately. The Squarespace order response does not establish a chargeback.
You should seeThe test order's facts match Squarespace; missing dispute evidence stays missing in draft intake.
Option 2: approve the Revient OAuth application
Use this when Revient's application is configured for your site. You approve access; Revient owns its application credentials and callback setup.
Continue from Revient to Squarespace
Revient → Integrations → Squarespace → Connect with Squarespace OAuth
- Choose Continue to Squarespace. Sign in on Squarespace if prompted.
- Select the correct site and review the order and transaction read permissions. Choose Allow to approve the connection.
- If Revient reports that OAuth is not configured, ask Revient support to complete the operator setup below or use an eligible API key.
You should seeSquarespace returns you to Revient and the authorised site appears in connection management.Verify sync, then enable optional order notifications
Revient → selected Squarespace store → Manage / Set up webhooks
- Run Check connection and Sync now, then compare a known source order in intake.
- For this OAuth-connected store, open Set up webhooks. Use the selected store's inbound setup to register supported order notifications.
- Revient registers order.create, order.update and extension.uninstall, and verifies signed incoming notifications. API-key connections do not offer this setup.
You should seeA successful sync is visible; if webhook setup succeeds, the selected store has its own inbound subscription.
Revient operator: prepare the shared OAuth applicationRevient operator setup. Customers do not need to register their own Revient app.
Revient operator: prepare the shared OAuth application
This configuration belongs to the Revient team. Merchants using the OAuth path only select a site and approve access.
Configure Revient's application with Squarespace
Squarespace account → developer-apps dashboard
- Open account.squarespace.com/developer-apps using Revient's application-owner account and follow its current registration process.
- Supply Revient's application identity and required policy details, and register the exact deployed redirect URI shown below. Complete any Squarespace requirements before offering the connection to merchants.
- Squarespace's help now directs new OAuth registrations to this dashboard; do not send merchants to the retired credentials-request form.
You should seeRevient has application credentials and a registered callback for the intended environment.Configure and verify the Revient runtime
Revient operator's server configuration
- Set SQUARESPACE_CLIENT_ID and SQUARESPACE_CLIENT_SECRET through the server's secret configuration. Set APP_URL to the correct public HTTPS origin.
- The implemented OAuth request uses website.orders.read,website.transactions.read and access_type=offline. Test a complete merchant approval and return through the registered callback.
- Verify refresh and reconnect with the test account, then validate order/transaction access and a signed webhook event before declaring the source live-verified.
You should seeA merchant can approve access without supplying application credentials. Connection, refresh and inbound notification checks have recorded outcomes.
Review the collected evidence
Check the source facts and processing result after completing the provider-specific connection steps.
Check the case and automatic evidence results
Revient → Integrations → Intake, then Cases → Evidence
- Compare the order email, billing/shipping names and addresses against the original order. Check transactions separately and retain source refund statuses.
- Shopify intake accepts only CHARGEBACK disputes with final status LOST and a verified remaining disputed balance. Inquiries, won and open outcomes are excluded before customer enrichment, tracking, scoring and AI.
- Confirmed lost chargebacks with missing facts appear in Cases as Needs information. Missing facts remain unknown until supported by evidence.
- Historical non-qualifying records remain in internal audit history, outside merchant intake and active Cases.
- Cases combines retained Test and ordinary records. A small Test badge identifies records that cannot be routed, sold or counted in live financial totals. AI still requires its approved configuration and valid permissions.
- For each outbound, replacement or return parcel, check the tracking number, event dates and item coverage. Registration requires a confirmed lost dispute and verified notification-disabled settings. Delivery photos and signatures are separate private assets; unavailable assets are labelled, and a recipient postcode does not prove the delivery address.
- Use the row menu for one case. Select at least two checkboxes to show bulk actions. Refresh evidence requests current connected-source data and then checks it; Recheck stored evidence uses the facts already retained. Follow each row's progress and refusal reason.
- Archive retains history and may be blocked by active obligations. Use the Archived filter to restore a case. Reimporting its source does not restore it.
You should seeYou can identify the current evidence, unknown fields, processing state and next merchant action without losing historical assessments.
Match these fields in Revient
Enter your own account’s values. Example values are for orientation; do not paste them as credentials.
| Revient field | Where to find it | Example / guidance |
|---|---|---|
| Commerce API keyKeep private | Your site → Developer tools → Developer API Keys → Generate Key. | Paste your dedicated Orders/Transactions read key |
| OAuth merchant connection | Revient → Squarespace → Continue to Squarespace. | Choose the intended site and approve the permissions; no client secret to paste |
| Operator: SQUARESPACE_CLIENT_ID / SQUARESPACE_CLIENT_SECRETKeep private | Revient's registered application in the Squarespace developer-apps dashboard. | Store the issued application credentials in server configuration |
| Operator: registered redirect URI | The callback for the deployed Revient environment. | https://www.revient.io/api/storefronts/squarespace/callback |
Callback address for the Revient operatorOnly the operator configures this address in the provider application.
Register the complete address, including the path:https://www.revient.io/api/storefronts/squarespace/callback
If something goes wrong
Orders or Transactions is missing from key permissions
Verify the site's current plan and ownership. Plan names and older menus differ; the site's available API permissions are the final check. Use CSV import until the required API access is available.
The wrong site was connected
Disconnect that Revient connection and create or approve a credential for the correct site. A key or OAuth grant does not cover every site in your account.
OAuth is not configured / redirect mismatch
The Revient operator must verify its client credentials, APP_URL and the exact registered callback. Merchants do not repair this by generating an application client secret.
401 / refresh rejected
Reconnect and approve the site again. Squarespace rotates refresh tokens; an expired or revoked grant needs a new authorisation.
Webhook option unavailable
Check the selected store's connection type. Squarespace's Webhook Subscriptions API requires OAuth; an API key supports sync but cannot register these subscriptions.
Connection is healthy but payment details are incomplete
The connection check proves site identity and order access. Review Transactions permission and the original source transaction before using missing payment facts in an assessment.
Common questions
What evidence does Squarespace supply?
Commerce orders, payment and refund status, and fulfilment with tracking. An authorisation result is used only when the transaction record contains it. The lost chargeback comes from the payment provider.
Should a customer create a Squarespace developer application?
No for the Revient OAuth path. Revient manages that application. The separate API-key testing path requires the site owner to create a dedicated key.
Can I use webhooks with my API key?
No. Squarespace requires OAuth for its Webhook Subscriptions API. Continue with Sync now, or reconnect through OAuth when available.
How do I revoke the connection?
Disconnect in Revient to stop new reads. For an API key, delete that dedicated key in Squarespace's Developer API Keys panel; for OAuth, revoke Revient's access in Squarespace. Previously selected test evidence is retained until you explicitly remove or replace it.
What is the difference between Refresh evidence and Recheck stored evidence?
Refresh evidence queues new reads from available connected sources and already selected mailbox messages, then tracking and reassessment. Recheck stored evidence reassesses the retained facts without claiming a new provider read. Existing findings stay visible until the work finishes; unavailable sources and partial refusals are reported for each case.
Which disputes receive recovery scoring?
Shopify intake accepts only CHARGEBACK disputes with final status LOST and a verified remaining disputed balance. Inquiries, won and open outcomes are excluded before customer enrichment, tracking, scoring and AI. Historical non-qualifying records remain in internal audit history, outside merchant intake and active Cases. An order or tracking number alone does not establish a lost dispute. Supply the actual confirmed loss and preserve its original order and dispute identities.
Will testing send messages or release a case?
Evidence-testing mode blocks customer, agency and buyer delivery. Importing records or reviewing an assessment does not release a case.
What happens when I disconnect?
New reads stop and the Revient connection is disabled. Evidence already retained remains subject to the workspace retention and removal controls. Revoke the application or key in the provider account as well if you want to remove its access there.
Source documentation
Use these provider pages if a menu name has moved or your plan shows different options.