Publish Scheduled Shift - Automate.ax

square.publishScheduledShift publishes a scheduled shift.

Example

automations/square-publish-scheduled-shift.automation.ts

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

export default automation("Publish Square Scheduled Shift", () => {
  onDashboardRun({ title: "Publish Square Scheduled Shift" })

  square.publishScheduledShift({
    id: "id",
    idempotencyKey: "HIDSNG5KS478L",
    version: 2,
    scheduledShiftNotificationAudience: "ALL",
  })
})

Inputs

Every input accepts a compatible signal. It requires TIMECARDS_WRITE.

Field	Type	Required	Default	Description
`id`	`string`	Yes	—	The ID of the scheduled shift to publish.
`idempotencyKey`	`string`	Yes	—	A unique identifier for the `PublishScheduledShift` request, used to ensure the idempotency of the operation.
`version`	`number`	No	—	The current version of the scheduled shift, used to enable optimistic concurrency control. If the provided version doesn’t match the server version, the request fails. If omitted, Square executes a blind write, potentially overwriting data from another publish request.
`scheduledShiftNotificationAudience`	`Square.ScheduledShiftNotificationAudience`	No	`AFFECTED`	Indicates whether Square should send an email notification to team members and which team members should receive the notification. The default value is `AFFECTED`. See ScheduledShiftNotificationAudience for possible values

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

Output

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