Update Workflow

updateWorkflow Mutation

Updates an existing Workflow definition in the system with new data.

Arguments

Name	Type	Description
id	ID!	The unique identifier of the workflow to update
input	UpdateWorkflowInput!	Input data for updating the workflow

Return Type

Workflow - The updated workflow definition.

Input Fields

UpdateWorkflowInput:

Field	Type	Description
dataTypeID	UUID	Optional data type ID to associate with the workflow
clearDataTypeID	Boolean	Clear the existing data type ID
dataTypeSlug	String	Optional data type slug
clearDataTypeSlug	Boolean	Clear the existing data type slug
data	Map	Custom data associated with the workflow
clearData	Boolean	Clear the existing custom data
name	String	Name of the workflow
active	Boolean	Whether the workflow is active and can be triggered
filterRule	String	Filter rule to determine when this workflow should be triggered
clearFilterRule	Boolean	Clear the existing filter rule
addWorkflowSignalIDs	[ID!]	IDs of workflow signals to add to this workflow
removeWorkflowSignalIDs	[ID!]	IDs of workflow signals to remove from this workflow
clearWorkflowSignals	Boolean	Clear all associated workflow signals

Usage Example

mutation {
  updateWorkflow(
    id: "workflow_123"
    input: {
      name: "Enhanced Inventory Restock Workflow",
      active: true,
      filterRule: "(item.quantity < item.minimum_stock) OR (item.quantity == 0)",
      data: {
        "description": "Enhanced workflow with zero-stock handling",
        "priority": "critical",
        "department": "inventory_management",
        "notification_channels": ["email", "slack", "sms"],
        "escalation_rules": {
          "after_hours": 1,
          "business_hours": 2
        },
        "auto_reorder": true,
        "reorder_multiplier": 1.5
      },
      dataTypeSlug: "critical_inventory_workflow",
      addWorkflowSignalIDs: ["signal_789"]
    }
  ) {
    id
    name
    active
    filterRule
    data
    dataTypeSlug
    updatedAt
    updatedBy
    workflowSignals {
      id
      eventName
      start
    }
  }
}

JavaScript Example

const UPDATE_WORKFLOW = gql`
  mutation UpdateWorkflow($id: ID!, $input: UpdateWorkflowInput!) {
    updateWorkflow(id: $id, input: $input) {
      id
      name
      active
      filterRule
      data
      dataTypeSlug
      updatedAt
      updatedBy
      workflowSignals {
        id
        eventName
        start
      }
    }
  }
`;

const { data } = await client.mutate({
  mutation: UPDATE_WORKFLOW,
  variables: {
    id: "workflow_123",
    input: {
      name: "Enhanced Inventory Restock Workflow",
      active: true,
      filterRule: "(item.quantity < item.minimum_stock) OR (item.quantity == 0)",
      data: {
        description: "Enhanced workflow with zero-stock handling",
        priority: "critical",
        department: "inventory_management",
        notification_channels: ["email", "slack", "sms"],
        escalation_rules: {
          after_hours: 1,
          business_hours: 2
        },
        auto_reorder: true,
        reorder_multiplier: 1.5
      },
      dataTypeSlug: "critical_inventory_workflow",
      addWorkflowSignalIDs: ["signal_789"]
    }
  }
});

console.log(`Updated workflow: ${data.updateWorkflow.name}`);

Important Notes

• Updating a workflow may affect running workflow instances depending on the changes

• Use the clear flags to explicitly remove optional fields

• The data field supports flexible JSON structures for workflow configuration

• Changes to the filterRule will affect when the workflow is triggered in the future

• Deactivating a workflow (active: false) will prevent new instances from starting

• Workflow signal associations can be managed incrementally using add/remove operations

• Consider the impact on existing workflow instances when making significant changes