Skip to main content
Oboard logo
  • Category: productivity
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 32
  • Triggers: 0
  • Slug: OBOARD
  • Version: 20261101_00

Tools

Slug: OBOARD_ADD_USERS_TO_GROUPAdd one or more existing Oboard users to a group. Use only when the connected deployment exposes group membership management; Web app connections reject this operation.

Input Parameters

integer
required
Numeric ID of the group receiving the users.
array
required
Account IDs of users to add; at least one nonempty ID is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_CREATE_CHECKINCreate a check-in that records a progress value, status, or comment for an Oboard element. When checkin_date is supplied, Oboard stores its UTC calendar day and may replace the time with 23:59:59.000Z.

Input Parameters

string
Check-in comment; at least one of new_value, new_status, or comment is required.
number
New progress value; at least one of new_value, new_status, or comment is required.
string
required
Account ID of the check-in author. The current OpenAPI marks this optional, but the live provider rejects its omission.
integer
required
Element receiving the check-in.
integer
New status identifier; at least one of new_value, new_status, or comment is required.
string
Check-in calendar date in ISO 8601 format. Oboard may ignore the supplied time of day and store 23:59:59.000Z; omit to use the current date.
boolean
Whether to update the status of nested elements; explicit null is sent as null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_CREATE_ELEMENTCreate an Oboard objective, key result, or Jira-linked element in a workspace and interval. Oboard requires integer manual start-date and due-date states plus grade mode 1 (automatic) or 2 (manual).

Input Parameters

string
required
Element name.
string
Metric unit.
array
User assignments and their element role IDs. The API docs mark this field optional, but omission sends an empty array because the live runtime requires the key.
array
Groups to assign, identified by numeric group ID. The API docs mark this field optional, but omission sends an empty array because the live runtime requires the key.
boolean
Whether the new element is private. The live provider applies the private key; the OpenAPI’s isPrivate key is accepted but ignored.
string
Calculated or effective ISO 8601 calendar date or calendar timestamp. Oboard receives it normalized to UTC with millisecond precision.
integer
required
Strategic component for the element.
array
Label IDs to assign.
integer
Parent element ID; omit for a root element.
boolean
Whether this element contributes to its parent.
integer ("1" | "2")
required
Required grade mode: 1 for automatic or 2 for manual.
string
Effective ISO 8601 calendar date or calendar timestamp. Oboard receives it normalized to UTC with millisecond precision.
string
Element description.
integer
required
Interval in which to create the element.
number
Target measured value.
integer
required
Workspace in which to create the element.
number
Initial measured value.
object
Custom-field values keyed by custom-field ID.
integer
Measurement field type ID.
integer
Metric granulation configuration ID. Oboard does not publish accepted IDs; use a value from an existing compatible element.
array
Jira issue IDs to link.
number
Baseline value for progress calculations.
integer
required
Required int32 manual due-date state. Oboard does not publish accepted values; 0 is live-verified.
integer
required
Required int32 manual start-date state. Oboard does not publish accepted values; 0 is live-verified.
integer ("1" | "2" | "3" | "4" | "5" | "6" | "9")
Initial confidence state: 1 on track, 2 behind, 3 at risk, 4 not started, 5 closed, 6 abandoned, or 9 backlog.
boolean
Apply relevant status changes to nested elements.
integer
Period aggregation configuration ID. Oboard does not publish accepted IDs; use a value from an existing compatible element.
integer
Threshold-condition configuration ID. The live provider requires this for numeric KPI elements using field_type_id 6. Copy the ID from a compatible element returned by GET_ELEMENT; Oboard does not publish accepted IDs.
integer
Progress aggregation configuration ID. Oboard does not publish accepted IDs; use a value from an existing compatible element.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_CREATE_ELEMENT_VALUECreate a dated numeric value for an Oboard element. value_date is required in YYYY-MM-DD format and cannot be after the current UTC date. Oboard returns only a confirmation string, not the created value ID; use LIST_ELEMENT_VALUES to identify the resulting record.

Input Parameters

string
required
Numeric value to record. Required by this action so the creation has an agent-observable value; explicit null is sent as null.
integer
required
Element that will receive the dated value.
string
required
Date to record in YYYY-MM-DD format. Oboard rejects timestamps and dates after the current UTC date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_CREATE_GROUPCreate an Oboard group in selected workspaces or all workspaces.

Input Parameters

integer
required
Group icon number from 1 through 32.
string
required
Group name.
string ("#B5BBC5" | "#CBCFD6" | "#DFE1E6" | "#85B2DD" | "#A7C4EC" | "#BFD4F2" | "#86D1B2" | "#AFE0CB" | "#CDECDF" | "#B69EF3" | "#CAC0F5" | "#D6D4F6" | "#F8768A" | "#FAA4B1" | "#FDD1D8" | "#FFA370" | "#FCC289" | "#FDE1B8")
required
Group color from Oboard’s documented palette.
integer
Parent group ID; omit to create a root group.
array
Workspace IDs for the group; required unless add_to_all_workspaces is true. An empty list is accepted by Oboard.
array
External platform group IDs to link.
boolean
Whether to synchronize the group with the linked platform.
boolean
Add the group to every existing workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_CREATE_STRATEGIC_COMPONENTCreate an Oboard strategic component with its ordering, type, workspace placement, and element rules. Oboard documents no delete action for a created strategic component, so creation may be permanent.

Input Parameters

string
required
Component name, at most 20 characters.
string
required
Six-digit RGB hex color. A leading # is accepted and removed because Oboard level colors omit it.
string
required
Display prefix for the component. Oboard publishes no length limit.
integer
required
Provider component type ID. Oboard does not publish an allowed-value enum.
number
required
Component ordering value.
array
Specific workspace IDs when not adding the component to all workspaces; may be null.
array
Measurement field type IDs supported by the component; may be null.
boolean
Whether elements may use this component without a parent; may be null.
boolean
required
Whether to add the component to all workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_DELETE_ELEMENTDelete one Oboard element and optionally its nested objectives.

Input Parameters

integer
required
Numeric ID of the element to delete.
boolean
Also delete nested objectives. Defaults to false so nested objectives remain intact when Oboard supports preserving them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_DELETE_ELEMENT_VALUEDelete one dated value record from an Oboard element.

Input Parameters

integer
required
Value record to delete.
integer
required
Element that owns the value record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_DELETE_GROUPDelete one Oboard group, optionally deleting its users too.

Input Parameters

integer
required
Numeric ID of the group to delete.
boolean
Keep the group’s users when deleting the group. Defaults to true for safety; set false only when those users should also be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_GET_ELEMENTRetrieve one current Oboard element by its numeric ID.

Input Parameters

integer
required
Numeric ID of the element to retrieve.
array
Workspace IDs used to resolve the element when needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_CHILD_ELEMENTSList and filter current child elements below a parent, including manual-weight metadata, one page at a time.

Input Parameters

integer
Maximum child elements in this page.
array
Sort criteria for top-level child elements, in priority order.
Text to match in child element names or display IDs.
array
Element types to include: 1 objective, 4 key result, or 5 Jira issue.
array
Group IDs to include.
array
Label IDs to include.
array
Strategic component IDs to include.
array
Owner account IDs to include.
integer
required
Parent element ID whose children to list.
array
Sort criteria for nested child elements, in priority order.
string
Maximum due timestamp in ISO 8601 format.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
integer
required
View context: 1 Explorer, 2 Bottom up, 3 Check in, 4 Check-in objective, or 5 Check-in key result.
array
Watcher account IDs to include.
array
Interval IDs to include.
string
Minimum due timestamp in ISO 8601 format.
string
Maximum element start timestamp in ISO 8601 format.
array
Workspace IDs to include.
array
Stakeholder account IDs to include.
string
Minimum element start timestamp in ISO 8601 format.
array
Confidence states to include.
string
Maximum last progress-update timestamp in ISO 8601 format.
string
Minimum last progress-update timestamp in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_CONFIDENCE_LEVELSList Oboard confidence-level IDs and names, optionally restricted to accessible workspaces.

Input Parameters

array
Workspace IDs whose confidence levels to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_CUSTOM_FIELDSList Oboard custom-field definitions across accessible workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_ELEMENT_COMMENTSRetrieve comments for one or more Oboard elements. Date bounds are inclusive and are enforced locally because Oboard does not consistently apply them.

Input Parameters

boolean
Whether Oboard should return comment content rendered as HTML.
string
Latest comment timestamp to include, in ISO 8601 format.
string
Earliest comment timestamp to include, in ISO 8601 format.
array
required
One or more element IDs whose comments to retrieve. The live Oboard API rejects date-only requests even though its OpenAPI marks this field optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_ELEMENT_PROGRESS_HISTORYRetrieve dated progress values for multiple Oboard elements, one page at a time.

Input Parameters

integer
Maximum history records in this page.
string
Latest history date to include, in YYYY-MM-DD format.
string
Earliest history date to include, in YYYY-MM-DD format.
array
required
Element IDs whose progress histories to retrieve.
string
Opaque cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_ELEMENTSList and filter current Oboard objectives, key results, and Jira-linked elements, one page at a time.

Input Parameters

integer
Maximum elements in this page.
array
Sort criteria for top-level elements, in priority order.
string
Text to match in elements.
array
Element types: 1 objective, 4 key result, or 5 Jira issue.
array
Group IDs to include.
array
Label IDs to include.
array
Strategic component IDs to include.
array
Owner account IDs to include.
array
Parent element IDs to include.
array
Sort criteria for nested child elements, in priority order.
string
Include elements due at or before this ISO 8601 timestamp.
array
Specific element IDs to include.
string
Opaque cursor returned by a previous call; omit for the first page.
integer ("1" | "2" | "3" | "4" | "5")
View context: 1 Explorer, 2 Bottom up, 3 Check in, 4 Check-in objective, or 5 Check-in key result.
array
Watcher account IDs to include.
array
Interval IDs to include.
string
Include elements due at or after this ISO 8601 timestamp.
array
Element IDs whose children should be opened.
string
Include elements starting at or before this ISO 8601 timestamp.
array
Workspace IDs to include.
integer
Maximum hierarchy depth to open.
array
Stakeholder account IDs to include.
string
Include elements starting at or after this ISO 8601 timestamp.
array
Confidence states: 1 on track, 2 behind, 3 at risk, 4 not started, 5 closed, 6 abandoned, or 9 backlog.
string
Include elements whose progress was updated at or before this ISO 8601 timestamp.
string
Include elements whose progress was updated at or after this ISO 8601 timestamp.
boolean
Include cross-workspace objectives.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_ELEMENT_VALUESList all dated values recorded for one Oboard element.

Input Parameters

integer
required
Element whose dated values to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_GROUPSList current Oboard groups and their workspace, permission, synchronization, and user-count metadata.

Input Parameters

array
Workspace IDs to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_INTERVALSList planning intervals, dates, and open or backlog state for one workspace.

Input Parameters

integer
required
Workspace whose planning intervals to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_LABELSList current Oboard labels, optionally filtered by name.

Input Parameters

string
Label name text to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_STRATEGIC_COMPONENTSList current Oboard strategic components, optionally filtered by component or workspace IDs.

Input Parameters

array
Workspace IDs to include.
array
Strategic component IDs to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_USERSSearch current Oboard users across workspaces, roles, and groups, one page at a time.

Input Parameters

integer
Maximum users in this page.
string
Text to match against user names or email addresses.
array
Workspace role IDs to include.
array
Group IDs to include.
string
Opaque cursor returned by a previous call; omit for the first page.
integer
Restrict users to one workspace ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_LIST_WORKSPACESList workspaces accessible to the connected Oboard API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_REMOVE_USERS_FROM_GROUPRemove one or more existing Oboard users from a group. Use only when the connected deployment exposes group membership management; Web app connections reject this operation.

Input Parameters

integer
required
Group from which to remove users.
array
required
Account IDs of users to remove; at least one ID is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_REPLACE_ELEMENTUpdate an existing Oboard element through its broad PUT operation, which can set editable metadata, hierarchy, progress, assignments, integer manual-date states, and privacy in one call. The request sends the element ID and only optional fields you provide; explicit null values are sent, while omitted fields are not sent, and Oboard does not document whether omission preserves or resets them.

Input Parameters

string
Replacement element name.
string
Replacement metric unit.
number
Replacement grade value.
array
Replacement user assignments.
array
Replacement group assignments.
boolean
Replacement privacy setting.
string
Replacement effective due timestamp in ISO 8601 format.
integer
Replacement strategic component ID.
array
Replacement label IDs.
integer
Replacement parent element ID.
boolean
Whether the element contributes to its parent.
integer
required
Element ID to replace.
integer ("1" | "2")
Replacement grade mode: 1 automatic or 2 manual.
string
Replacement effective start timestamp in ISO 8601 format.
string
Replacement description.
integer
Replacement interval ID.
integer
Replacement position among sibling elements.
number
Replacement target value.
integer
Replacement workspace ID.
number
Replacement current value.
object
Replacement custom-field map keyed by custom-field ID.
integer
Replacement measurement field type.
string
Replacement linked Jira issue ID.
integer
Replacement metric granulation configuration ID. Oboard does not publish accepted IDs; use a value from the target element.
number
Replacement baseline value.
integer
Optional nullable int32 manual due-date state. Oboard does not publish accepted values; 0 is live-verified.
integer
Optional nullable int32 manual start-date state. Oboard does not publish accepted values; 0 is live-verified.
integer ("1" | "2" | "3" | "4" | "5" | "6" | "9")
Replacement confidence state: 1 on track, 2 behind, 3 at risk, 4 not started, 5 closed, 6 abandoned, or 9 backlog.
boolean
Apply relevant status changes to nested elements.
integer
Replacement period aggregation configuration ID. Oboard does not publish accepted IDs; use a value from the target element.
integer
Replacement threshold-condition configuration ID. It is required by the live provider for numeric KPI elements using field_type_id 6; copy the current ID from GET_ELEMENT because Oboard does not publish accepted IDs.
integer
Replacement progress aggregation configuration ID. Oboard does not publish accepted IDs; use a value from the target element.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_REPLACE_GROUPReplace the settings, workspace links, platform links, and membership list of an existing Oboard group. Use only when the connected deployment exposes group management; Web app connections reject this operation.

Input Parameters

integer
required
Replacement icon number from 1 through 32.
string
required
Replacement group name.
string ("#B5BBC5" | "#CBCFD6" | "#DFE1E6" | "#85B2DD" | "#A7C4EC" | "#BFD4F2" | "#86D1B2" | "#AFE0CB" | "#CDECDF" | "#B69EF3" | "#CAC0F5" | "#D6D4F6" | "#F8768A" | "#FAA4B1" | "#FDD1D8" | "#FFA370" | "#FCC289" | "#FDE1B8")
required
Replacement group color from Oboard’s documented palette.
boolean
required
Whether platform synchronization is enabled.
integer
required
ID of the group to replace.
integer
Replacement parent group ID, or null for no parent.
array
required
Complete replacement list of workspace IDs; use all accessible IDs when adding the group to all workspaces if required by Oboard.
array
required
Complete replacement list of linked platform group IDs; use an empty list for none.
boolean
required
Whether the group belongs to all accessible workspaces.
array
required
Complete replacement list of platform user account IDs; use an empty list for none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_SEARCH_CHECKINSSearch Oboard check-ins by element, check-in ID, owner, group, or creation date, one page at a time. Optionally include element or comment details.

Input Parameters

array
Check-in IDs to include; an empty list is preserved.
integer
Maximum check-ins to return in this page.
array
Group IDs whose check-ins to include; an empty list is preserved.
string
Latest check-in creation timestamp in ISO 8601 format.
array
Element IDs whose check-ins to search; optional when using other filters.
string
Opaque cursor returned by a previous call; omit for the first page.
string
Earliest check-in creation timestamp in ISO 8601 format.
array
Account IDs of check-in owners to include; an empty list is preserved.
boolean
required
Include related element data in each check-in.
boolean
required
Include detailed comment data in each check-in.
boolean
required
Include check-ins created by users in the element’s groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_UPDATE_CHECKINUpdate an existing Oboard check-in’s progress value, status, or comment. At least one change is required. When checkin_date is supplied, Oboard stores its UTC calendar day and may replace the time with 23:59:59.000Z. When it is omitted or null, Oboard chooses the resulting date.

Input Parameters

string
Replacement check-in comment; provide this, new_value, or new_status.
number
Replacement progress value; provide this, new_status, or comment.
string
required
Account ID of the user making the update.
integer
required
Numeric ID of the check-in to update.
integer
Replacement status ID; provide this, new_value, or comment.
string
Replacement check-in calendar date in ISO 8601 format. Oboard may ignore the supplied time of day and store 23:59:59.000Z; when omitted or null, Oboard chooses the resulting date.
boolean
Apply relevant status changes to nested elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_UPDATE_ELEMENT_PROPERTIESUpdate one or more named properties on an existing Oboard element without replacing the complete element.

Input Parameters

integer
required
Numeric ID of the element to update.
array
required
Property updates to apply; at least one is required. The officially documented example is property_name name with a string new_value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_UPDATE_ELEMENT_VALUEUpdate the numeric value of one Oboard element-value record. Oboard documents new_value as optional and nullable; this action requires it so the call can perform an agent-observable update. The provider returns only a confirmation string; value_id remains the record identifier.

Input Parameters

integer
required
Value record to update.
string
required
Replacement numeric value. Required by this action so the update has an agent-observable value; explicit null is sent as null.
integer
required
Element that owns the value record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_UPDATE_STRATEGIC_COMPONENTUpdate an existing Oboard strategic component’s identity, ordering, and element rules. This changes a shared hierarchy component that can affect elements across its workspaces.

Input Parameters

string
required
Replacement component name, at most 20 characters. Required and nullable.
string
required
Replacement six-digit RGB hex color. Required and nullable; a leading # is removed before sending.
string
required
Replacement display prefix. Required and nullable; Oboard publishes no length limit.
integer
required
Strategic component ID to update. The provider OpenAPI permits null, but this action requires an ID so the shared hierarchy target and response can be verified.
string
required
Replacement ordering value. Required and nullable.
array
Replacement measurement field type IDs; may be null.
boolean
Whether elements may use this component without a parent; may be null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OBOARD_UPDATE_USER_ROLESBulk update users’ workspace roles. This changes user authorization; use only with the intended account, workspace, and role IDs.

Input Parameters

array
required
Authorization changes to apply; at least one complete account, workspace, and intended role assignment is required. The provider OpenAPI permits empty or partial entries, but those cannot identify an authorization change and are rejected by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not