Functions reference

This section contains auto-generated documentation for 187 Convex functions across 38 modules. Each page shows the function type, arguments, and any available documentation.

Generated from Convex source files at commit 42c357d1.

Modules

programs

Function	Link
list	programs.list
get	programs.get
create	programs.create
update	programs.update
updatePhase	programs.updatePhase
getStats	programs.getStats
remove	programs.remove
getBySlug	programs.getBySlug
getNavigationState	programs.getNavigationState
suggestWorkstreams	programs.suggestWorkstreams

workstreams

Function	Link
listByProgram	workstreams.listByProgram
get	workstreams.get
update	workstreams.update

requirements

Function	Link
listByProgram	requirements.listByProgram
get	requirements.get
create	requirements.create
update	requirements.update
updateStatus	requirements.updateStatus
countByStatus	requirements.countByStatus
countByPriority	requirements.countByPriority
listAllByProgram	requirements.listAllByProgram
listWithPipelineContext	requirements.listWithPipelineContext
pipelineStageCounts	requirements.pipelineStageCounts
bulkAssignWorkstream	requirements.bulkAssignWorkstream
remove	requirements.remove

skills

Function	Link
listByProgram	skills.listByProgram
get	skills.get
create	skills.create
update	skills.update
updateContent	skills.updateContent
linkRequirement	skills.linkRequirement
unlinkRequirement	skills.unlinkRequirement
listTemplates	skills.listTemplates
forkTemplate	skills.forkTemplate

skillVersions

Function	Link
listBySkill	skillVersions.listBySkill
get	skillVersions.get
compare	skillVersions.compare

risks

Function	Link
listByProgram	risks.listByProgram
get	risks.get
create	risks.create
update	risks.update
updateStatus	risks.updateStatus
remove	risks.remove

tasks

Function	Link
listByProgram	tasks.listByProgram
get	tasks.get
create	tasks.create
update	tasks.update
updateStatus	tasks.updateStatus
remove	tasks.remove
countBySprint	tasks.countBySprint
listUnassignedByWorkstream	tasks.listUnassignedByWorkstream
bulkAssignToSprint	tasks.bulkAssignToSprint

subtasks

Function	Link
listByTask	subtasks.listByTask
get	subtasks.get
create	subtasks.create
update	subtasks.update
updateStatus	subtasks.updateStatus
reorder	subtasks.reorder
remove	subtasks.remove

sprints

Function	Link
listByProgram	sprints.listByProgram
listByWorkstream	sprints.listByWorkstream
get	sprints.get
create	sprints.create
update	sprints.update
activate	sprints.activate
complete	sprints.complete
getActive	sprints.getActive
remove	sprints.remove

sprintGates

Function	Link
listByProgram	sprintGates.listByProgram
listByWorkstream	sprintGates.listByWorkstream
get	sprintGates.get
create	sprintGates.create
evaluateCriterion	sprintGates.evaluateCriterion
addApproval	sprintGates.addApproval
finalize	sprintGates.finalize
remove	sprintGates.remove

agentExecutions

Function	Link
listByProgram	agentExecutions.listByProgram
get	agentExecutions.get
getDetail	agentExecutions.getDetail
listRecent	agentExecutions.listRecent
listByTask	agentExecutions.listByTask
updateReview	agentExecutions.updateReview

users

Function	Link
getByClerkId	users.getByClerkId
list	users.list
syncActiveOrg	users.syncActiveOrg

teamMembers

Function	Link
listByProgram	teamMembers.listByProgram
add	teamMembers.add
update	teamMembers.update
remove	teamMembers.remove

auditLog

Function	Link
listByProgram	auditLog.listByProgram
listByEntity	auditLog.listByEntity

notifications

Function	Link
listUnread	notifications.listUnread
listRecent	notifications.listRecent
markRead	notifications.markRead
markAllRead	notifications.markAllRead

documents

Function	Link
generateUploadUrl	documents.generateUploadUrl
save	documents.save
listByProgram	documents.listByProgram
get	documents.get
update	documents.update
remove	documents.remove

comments

Function	Link
listByEntity	comments.listByEntity
create	comments.create
remove	comments.remove

evidence

Function	Link
generateUploadUrl	evidence.generateUploadUrl
save	evidence.save
listByRequirement	evidence.listByRequirement
remove	evidence.remove

discoveryFindings

Function	Link
listByProgram	discoveryFindings.listByProgram
listByDocument	discoveryFindings.listByDocument
countPending	discoveryFindings.countPending
reviewFinding	discoveryFindings.reviewFinding
bulkReviewFindings	discoveryFindings.bulkReviewFindings
importApprovedFindings	discoveryFindings.importApprovedFindings

integrations

Function	Link
listByProgram	integrations.listByProgram
get	integrations.get
create	integrations.create
update	integrations.update
remove	integrations.remove

playbooks

Function	Link
listByProgram	playbooks.listByProgram
get	playbooks.get
create	playbooks.create
update	playbooks.update
publish	playbooks.publish
remove	playbooks.remove
instantiate	playbooks.instantiate

search

Function	Link
globalSearch	search.globalSearch

sandbox/sessions

Function	Link
get	sandbox/sessions.get
getByTask	sandbox/sessions.getByTask
listByProgram	sandbox/sessions.listByProgram
listByOrg	sandbox/sessions.listByOrg
cancel	sandbox/sessions.cancel
getChatMessages	sandbox/sessions.getChatMessages
sendChatMessage	sandbox/sessions.sendChatMessage
deleteSession	sandbox/sessions.deleteSession

sandbox/orchestrator

Function	Link
start	sandbox/orchestrator.start
startLocal	sandbox/orchestrator.startLocal
stop	sandbox/orchestrator.stop
wake	sandbox/orchestrator.wake
shutdown	sandbox/orchestrator.shutdown
startSubtaskExecution	sandbox/orchestrator.startSubtaskExecution
continueAfterPause	sandbox/orchestrator.continueAfterPause
retryFailedSubtask	sandbox/orchestrator.retryFailedSubtask

sandbox/configs

Function	Link
getByOrg	sandbox/configs.getByOrg
upsert	sandbox/configs.upsert
remove	sandbox/configs.remove

sandbox/presets

Function	Link
listForOrg	sandbox/presets.listForOrg
get	sandbox/presets.get
upsert	sandbox/presets.upsert
remove	sandbox/presets.remove

sandbox/envVault

Function	Link
listByOrg	sandbox/envVault.listByOrg
get	sandbox/envVault.get
upsert	sandbox/envVault.upsert
remove	sandbox/envVault.remove

sandbox/logs

Function	Link
listBySession	sandbox/logs.listBySession
listByTask	sandbox/logs.listByTask

sourceControl/repositories

Function	Link
connectRepository	sourceControl/repositories.connectRepository
disconnectRepository	sourceControl/repositories.disconnectRepository
listByProgram	sourceControl/repositories.listByProgram
getInstallation	sourceControl/repositories.getInstallation

sourceControl/installations

Function	Link
listByOrg	sourceControl/installations.listByOrg
claimInstallation	sourceControl/installations.claimInstallation

atlassian/connections

Function	Link
getByProgram	atlassian/connections.getByProgram
listByOrg	atlassian/connections.listByOrg
startOAuth	atlassian/connections.startOAuth
completeOAuth	atlassian/connections.completeOAuth
updateBindings	atlassian/connections.updateBindings
disconnect	atlassian/connections.disconnect

orchestration/runs

Function	Link
get	orchestration/runs.get
listByProgram	orchestration/runs.listByProgram
listActive	orchestration/runs.listActive
create	orchestration/runs.create
updateStatus	orchestration/runs.updateStatus

orchestration/planner

Function	Link
generatePlan	orchestration/planner.generatePlan
estimateCost	orchestration/planner.estimateCost

billing/subscriptions

Function	Link
getOrgSubscription	billing/subscriptions.getOrgSubscription
getOrgBillingState	billing/subscriptions.getOrgBillingState

billing/plans

Function	Link
getPricingPlans	billing/plans.getPricingPlans
getPlanBySlug	billing/plans.getPlanBySlug

billing/trial

Function	Link
getTrialState	billing/trial.getTrialState
getTrialStatus	billing/trial.getTrialStatus
initializeTrial	billing/trial.initializeTrial

billing/analytics

Function	Link
getOrgCostSummary	billing/analytics.getOrgCostSummary
getOrgCostTimeline	billing/analytics.getOrgCostTimeline

health/serviceHealth

Function	Link
getLatestHealthByService	health/serviceHealth.getLatestHealthByService
getActiveIncidents	health/serviceHealth.getActiveIncidents
recordHealthCheck	health/serviceHealth.recordHealthCheck