WorkflowSignal

WorkflowSignal Type

Represents a signal that can trigger workflow execution. WorkflowSignals connect events to workflows, defining when and how workflows should be started or signaled.

Fields

Field	Type	Description
id	ID!	Unique identifier of the workflow signal
tenantID	UUID!	Tenant identifier
dataTypeID	UUID	Data type identifier for custom data validation
dataTypeSlug	String	Data type slug for custom data validation
data	Map	Custom data associated with the workflow signal
createdAt	Time!	Creation timestamp
createdBy	UUID!	User identifier who created the workflow signal
updatedAt	Time	Last update timestamp
updatedBy	UUID	User identifier who last updated the workflow signal
deletedAt	Time	Deletion timestamp
deletedBy	UUID	User identifier who deleted the workflow signal
workflowID	ID!	Associated workflow identifier
eventName	String!	Name of the event that triggers this signal
start	Boolean!	Whether this signal starts a new workflow instance
workflow	Workflow!	Associated workflow

Interfaces

• Node

Usage Example

query {
  workflowSignals(first: 10) {
    edges {
      node {
        id
        eventName
        start
        workflow {
          id
          name
          active
        }
        data
        createdAt
        updatedAt
      }
    }
  }
}

Relations

• WorkflowSignal N:1 Workflow: A workflow signal belongs to one workflow

Purpose

WorkflowSignals act as the bridge between events and workflows in the system. When an event with the specified eventName occurs, the associated workflow will be triggered. The start field determines whether the signal creates a new workflow instance or signals an existing one. This enables event-driven workflow execution within the Temporal.io framework.