Create Workflow Signal

createWorkflowSignal Mutation

Creates a new WorkflowSignal that defines an event handler for a workflow.

Arguments

Name	Type	Description
input	CreateWorkflowSignalInput!	Input data for creating the workflow signal

Return Type

WorkflowSignal - The created workflow signal.

Input Fields

CreateWorkflowSignalInput:

Field	Type	Description
dataTypeID	UUID	Optional data type ID to associate with the signal
dataTypeSlug	String	Optional data type slug
data	Map	Custom data associated with the signal
eventName	String	Name of the event that this signal handles
start	Boolean	Whether this signal can start a new workflow instance
workflowID	ID!	Required ID of the workflow this signal belongs to

Usage Example

mutation {
  createWorkflowSignal(
    input: {
      eventName: "inventory_low_stock",
      start: true,
      workflowID: "workflow_123",
      data: {
        "description": "Triggered when inventory falls below minimum threshold",
        "priority": "high",
        "retry_policy": {
          "max_attempts": 3,
          "backoff_multiplier": 2.0
        },
        "timeout_seconds": 300,
        "required_fields": ["item_id", "current_quantity", "minimum_threshold"]
      },
      dataTypeSlug: "inventory_signal"
    }
  ) {
    id
    eventName
    start
    data
    dataTypeSlug
    createdAt
    createdBy
    workflow {
      id
      name
      active
    }
  }
}

JavaScript Example

const CREATE_WORKFLOW_SIGNAL = gql`
  mutation CreateWorkflowSignal($input: CreateWorkflowSignalInput!) {
    createWorkflowSignal(input: $input) {
      id
      eventName
      start
      data
      dataTypeSlug
      createdAt
      createdBy
      workflow {
        id
        name
        active
      }
    }
  }
`;

const { data } = await client.mutate({
  mutation: CREATE_WORKFLOW_SIGNAL,
  variables: {
    input: {
      eventName: "inventory_low_stock",
      start: true,
      workflowID: "workflow_123",
      data: {
        description: "Triggered when inventory falls below minimum threshold",
        priority: "high",
        retry_policy: {
          max_attempts: 3,
          backoff_multiplier: 2.0
        },
        timeout_seconds: 300,
        required_fields: ["item_id", "current_quantity", "minimum_threshold"]
      },
      dataTypeSlug: "inventory_signal"
    }
  }
});

console.log(`Created workflow signal: ${data.createWorkflowSignal.eventName} with ID: ${data.createWorkflowSignal.id}`);

Important Notes

• Workflow signals define the entry points and event handlers for workflows

• Signals with start: true can initiate new workflow instances when triggered

• Signals with start: false are used for signaling existing workflow instances

• The eventName should match the events that will be published in the system

• The data field supports flexible JSON structures for signal configuration

• Multiple signals can be associated with the same workflow for different events

• The workflow must exist before creating signals for it