Phases

A workflow's phases live in workspace/<WorkflowName>_<id>/phases.ts, exported as an array of HailerPhaseUpdatePayload. ws-config phases push applies them via phase.create / phase.update / phase.remove.

export const phases: HailerPhaseUpdatePayload[] = [
  { _id: "70a1...", name: "Lead", isInitial: true, color: "#3498db" },
  { _id: "70a2...", name: "In Progress" },
  { name: "Done", isEndpoint: true },   // new phase — no _id → created on push
];

Phase order is the array order — reorder the entries to reorder phases (the order property is server-managed and ignored). Removing a phase deletes it (snapshot-guarded, prompts unless --force). New phases (no _id) are created empty via phase.create, then all their properties are applied in a follow-up phase.update.

Properties

Property	Type	Description
name	string	Phase name.
description	string?	Phase description.
color	string?	Phase color (hex).
key	string?	Custom stable identifier.
isInitial	boolean?	The entry phase for new activities.
isEndpoint	boolean?	A terminal/completed phase.
fields	string[]?	Field ids shown while an activity is in this phase.
possibleNextPhase	string[]?	Phase ids an activity may move to from here.
possibleNextPhaseSettings	Record<string, { text?; name?; description? }>	Per-transition labels/config, keyed by target phase id.
primaryDateField	"created" | "updated" | "completedOn"	Which date drives calendar/timeline placement.
primaryNumericField	string?	Field id used as the phase's primary numeric metric.
followers	string[]?	User ids that follow activities in this phase.

Announcements

Property	Type	Description
enableAnnouncement	boolean?	Post a feed announcement when activities enter this phase.
announcementFields	string[]?	Field ids included in the announcement.
announcementFieldsOrder	string[]?	Order of those fields.
announcementRecipients	string[]?	Explicit recipient ids.
announcementToOwner	boolean?	Notify the activity owner.
announcementToOwnerTeam	boolean?	Notify the owner's team.
announcementAllowPrivateReply	boolean?	Allow private replies to the announcement.

Field options & webhooks

Property	Type	Description
fieldOptions	{ eventDateField?: string; dueDateField?: string }	Field ids used as the event/due dates for this phase.
webhooksEnabled	boolean?	Fire a webhook when activities enter this phase.
webhookUrl	string?	Webhook target URL.

Read-only / managed by the server

The SDK strips these before writing phases.ts and before hashing — editing them has no effect:

• _id (kept only for matching), uid, created.
• order — position is controlled by the array order in phases.ts, not this field.
• members — phase members cannot be updated through the SDK; there's no supported phase.update path for them (noted directly in the SDK's normalizePhase). Manage phase membership in the Hailer UI.
• webhookAdded, webhookUpdated — server-managed webhook state.

Command

ws-config phases push — creates, updates, and deletes phases per workflow.