Work with WorkBoard OKRs: goals and metrics, metric updates and tags, action items, teams, workstreams, meetings and users.
Explore 44 workflow actions for WorkBoard, including account permissions and operation limits.
27 read actions17 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add metric data
Write
Record a metric value, for the latest update period or a given update, with a comment.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add tags to metric
Write
Map up to 50 tags to a metric.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add tags to metrics
Write
Map tags to several metrics.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create action item
Write
Create an action item, with owner, workstream, due date, state, priority, rating, effort, tags and comments.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create goals
Write
Create goals with their metrics (data admin).
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create team
Write
Create a functional team (with parent_team_id) or working group, with members and workstreams.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create user
Write
Create a user in the organization, with an optional manager.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create workstream
Write
Create a workstream for a team, with an objective and owner.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete team
Write
Delete a team with all its workstreams and action items.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete workstream
Write
Delete a workstream with all its action items.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Disable user
Write
Disable a user's account and remove them from the organization.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get action item
Read
Read an action item with its subactions, comments, files and tags.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get goal
Read
Read a goal with its metrics.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get goal alignment
Read
List the goals aligned to and depending on a goal (data admin).
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get goal metric
Read
Read one metric of a goal.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get meeting
Read
Read a team or 1on1 meeting, with its agenda topics and takeaways if asked.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get metric
Read
Read one metric.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get my profile
Read
Read the token's user, or with include every organization or team member you can see (org_id is in the answer).
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get tag
Read
Read a key result tag.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get team
Read
Read a team.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get user
Read
Read a user's profile.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Get workstream
Read
Read a workstream.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List action items
Read
List action items by owner, due dates, priority, state, rating, effort or a preset filter, paged (50 by default).
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List goals
Read
List goals by owner, team owner, team or status, paged.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List metric tags
Read
List the tags on a metric.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List metrics
Read
List the metrics the token's user updates, by goal or goal owner, with chart data if asked.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List metrics with tag
Read
List the metrics mapped to a tag, paged.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List my goals
Read
List the goals the token's user owns, contributes to or updates.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List my teams
Read
List the teams the token's user manages or belongs to.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List tags
Read
List key result tags by status or tag group, paged.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List tags of metrics
Read
List the tags on several metrics.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List team action items
Read
List a team's action items.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List team workstreams
Read
List a team's workstreams.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List teams
Read
List the token's user's teams (or every team for a data admin), by role and dates, paged.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List user goals
Read
List a user's goals (you need permission to view them).
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List user teams
Read
List the teams a user manages or belongs to.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List workstream action items
Read
List a workstream's action items.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
List workstreams
Read
List the workstreams the token's user can see, by owner.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
Provision users
Write
Add, update or deactivate organization members in bulk (data admin; about 25 per call).
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove tags from metric
Write
Remove tags from a metric.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update action item
Write
Change an action item, or add comments or tags.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update team
Write
Rename a team, or move it under a parent (functional) or make it a working group.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update user
Write
Change a user's profile, time zone, status or manager.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update workstream
Write
Change a workstream's name, dates, pace, health or priority.
Permissions and limits
Account permissions
A WorkBoard access token; some calls need the data admin role
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in WorkBoard. A saved workflow is not a completed provider action.