Retrieve Snippet - Automate.ax

square.retrieveSnippet retrieves your snippet from a Square Online site.

Example

automations/square-retrieve-snippet.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Retrieve Square Snippet", () => {
  onDashboardRun({ title: "Retrieve Square Snippet" })

  square.retrieveSnippet({
    siteId: "site_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires ONLINE_STORE_SNIPPETS_READ.

Field	Type	Required	Default	Description
`siteId`	`string`	Yes	—	The ID of the site that contains the snippet.

Use the official RetrieveSnippet reference for provider field semantics and limits.

Output

Returns the official Square.GetSnippetResponse response as a codec-safe object. Square integer money amounts remain bigint values.