WorkflowSignals
Workflow Signals Query
Returns a paginated list of WorkflowSignal objects, with optional filtering and ordering. Workflow signals define events that can start or control workflow executions in the Temporal workflow engine.
Arguments
after
Cursor
Returns the elements in the list that come after the specified cursor
first
Int
Returns the first n elements from the list
before
Cursor
Returns the elements in the list that come before the specified cursor
last
Int
Returns the last n elements from the list
orderBy
WorkflowSignalOrder
Ordering options for workflow signals returned from the connection
where
WorkflowSignalWhereInput
Filtering options for workflow signals returned from the connection
Return Type
WorkflowSignalConnection! - A connection to a list of WorkflowSignal objects with pagination information.
Usage Example
query {
# Get workflow signals that start workflows
workflowSignals(
where: {
start: true
},
orderBy: { direction: DESC, field: CREATED_AT }
) {
edges {
node {
id
workflowID
eventName
start
dataTypeSlug
data
createdAt
workflow {
id
name
active
}
}
cursor
}
totalCount
}
}Common Filters
eventNameContains- Search by event name substringeventName- Find by exact event namestart- Filter by whether signal starts workflowworkflowID- Filter by associated workflowdataTypeSlug- Filter by data type slughasWorkflow- Filter signals that have associated workflowhasWorkflowWith- Filter by workflow criteriatenantID- Filter by tenant
Notes
Workflow signals connect events to workflow executions
Start signals trigger new workflow instances
Non-start signals control existing workflow instances
Event names correspond to business events in the system
Integration with Temporal.io workflow engine for reliable processing
Support custom fields through data/dataType system
Essential for event-driven workflow orchestration and process automation
Last updated
Was this helpful?
