Magidoc

createGoal
Mutation

Creates a Hive goal with owners, targets, dates, sharing, and optional action, project, or subgoal measurements. Progress display accepts null, number, or actions measurements; number display also accepts overdue, while status display requires status measurement. Actions and overdue use actions/projects units, number uses currency/custom/percentage, and status uses subGoals. Custom unit values may be caller-defined; other values and symbols must match their unit type. Ongoing, recurring, and fixed date modes are mutually exclusive; fixed requires both dates with startDate before endDate.

Arguments

#

workspace

ID !
Non-null

The workspace ID where this goal will be created

owners

[ID !]!
Non-null

User IDs who own this goal (must contain at least one element; empty arrays are not allowed and will be rejected at runtime)

teamOwners

[ID !]!
Non-null

Team IDs who own this goal

name

String !
Non-null

Goal name (cannot be empty string)

parentId

ID

Parent goal ID if this is a sub-goal

description

String !
Non-null

Goal description in HTML format

initialValue

Float !
Non-null

Initial numeric value for the goal

currentValue

Float !
Non-null

Current numeric value for the goal

goalValue

Float !
Non-null

Target numeric value for the goal

startDate

Date

Start date (requires endDate if provided)

endDate

Date

End date (required if startDate provided, must be after startDate)

ongoingDate

Boolean

Whether goal is ongoing (cannot combine with recurringDate or start/endDate)

recurringDate

GoalRecurringDateInput

Recurring schedule (cannot combine with ongoingDate or start/endDate)

measurementType

MeasurementType

How goal value is measured (null, number, actions, status, overdue)

measurementUnit

MeasurementUnit

Unit for measurement (currency, percentage, custom, actions, projects, subGoals)

measurementUnitValue

String !
Non-null

Specific value for the unit (e.g., 'USD', 'percentage', 'actions', 'projects', '' for subGoals)

measurementUnitSymbol

String !
Non-null

Symbol for the unit (e.g., '$', '%', '€', '¥', '£', 'AU$')

displayType

DisplayType !
Non-null

How goal is displayed (number, progress, status)

actionIds = []

[ID !]

Action IDs to track (requires measurementType actions/overdue + measurementUnit actions + measurementUnitValue 'actions')

includeSubActions

Boolean

Whether to include sub-actions in tracking

projectIds = []

[ID !]

Project IDs to track (requires measurementType actions/overdue + measurementUnit projects + measurementUnitValue 'projects')

associatedProjectIds = []

[ID !]

Project IDs associated with the goal for dashboard/reporting filters (not measurement; independent of projectIds)

sharingType

SharingTypes

Who can access this goal (me, custom, everyone)

sharingWith = []

[ID !]

User IDs to share with (only valid when sharingType is custom)

sourceWidgetId

ID

PivotNumbers widget backing automated currentValue updates

isFixedLimit

Boolean

Whether this number goal uses a fixed limit instead of expected progress by today.

isHigherBetter

Boolean

Whether higher values are healthier for a fixed-limit goal.

statusWarningValue

Float

Boundary above or below the fixed goal value. Values between them are at risk, including both boundaries.

statusUpdateMode

GoalStatusUpdateMode

Status update mode

statusUpdateRange

[GoalStatusUpdateRangeInput !]

Status update range rules

Response

#

Returns Goal .

Example

#