Update Workflow Signal

updateWorkflowSignal Mutation

Updates an existing WorkflowSignal with new data.

Arguments

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

Return Type

WorkflowSignal - The updated workflow signal.

Input Fields

UpdateWorkflowSignalInput:

Field	Type	Description
dataTypeID	UUID	Optional data type ID to associate with the signal
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 signal
clearData	Boolean	Clear the existing custom data
eventName	String	Name of the event that this signal handles
start	Boolean	Whether this signal can start a new workflow instance
workflowID	ID	ID of the workflow this signal belongs to

Usage Example

mutation {
  updateWorkflowSignal(
    id: "signal_456"
    input: {
      eventName: "inventory_critical_stock",
      start: true,
      data: {
        "description": "Enhanced signal for critical stock levels",
        "priority": "critical",
        "retry_policy": {
          "max_attempts": 5,
          "backoff_multiplier": 1.5
        },
        "timeout_seconds": 600,
        "required_fields": ["item_id", "current_quantity", "minimum_threshold", "critical_threshold"],
        "escalation_enabled": true,
        "auto_purchase_order": true
      },
      dataTypeSlug: "critical_inventory_signal"
    }
  ) {
    id
    eventName
    start
    data
    dataTypeSlug
    updatedAt
    updatedBy
    workflow {
      id
      name
      active
    }
  }
}

JavaScript Example

const UPDATE_WORKFLOW_SIGNAL = gql`
  mutation UpdateWorkflowSignal($id: ID!, $input: UpdateWorkflowSignalInput!) {
    updateWorkflowSignal(id: $id, input: $input) {
      id
      eventName
      start
      data
      dataTypeSlug
      updatedAt
      updatedBy
      workflow {
        id
        name
        active
      }
    }
  }
`;

const { data } = await client.mutate({
  mutation: UPDATE_WORKFLOW_SIGNAL,
  variables: {
    id: "signal_456",
    input: {
      eventName: "inventory_critical_stock",
      start: true,
      data: {
        description: "Enhanced signal for critical stock levels",
        priority: "critical",
        retry_policy: {
          max_attempts: 5,
          backoff_multiplier: 1.5
        },
        timeout_seconds: 600,
        required_fields: ["item_id", "current_quantity", "minimum_threshold", "critical_threshold"],
        escalation_enabled: true,
        auto_purchase_order: true
      },
      dataTypeSlug: "critical_inventory_signal"
    }
  }
});

console.log(`Updated workflow signal: ${data.updateWorkflowSignal.eventName}`);

Important Notes

• Updating a workflow signal may affect how future events are handled

• Use the clear flags to explicitly remove optional fields

• The data field supports flexible JSON structures for signal configuration

• Changing the eventName will change which events trigger this signal

• Changing start from true to false prevents the signal from initiating new workflows

• Moving a signal to a different workflow can be done by updating the workflowID

• Consider the impact on existing workflow instances when making changes