> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/queries/workflowsignals.md).

# 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

| Name      | Type                       | Description                                                            |
| --------- | -------------------------- | ---------------------------------------------------------------------- |
| `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

```graphql
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
  }
}
```

```graphql
query {
  # Search signals by event name
  workflowSignals(
    where: {
      eventNameContains: "order"
    },
    first: 20
  ) {
    edges {
      node {
        id
        workflowID
        eventName
        start
        data
        workflow {
          id
          name
          active
          filterRule
        }
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}
```

```graphql
query {
  # Get signals for specific workflow
  workflowSignals(
    where: {
      workflowID: "01234567-89ab-cdef-0123-456789abcdef"
    }
  ) {
    edges {
      node {
        id
        eventName
        start
        data
        createdAt
        workflow {
          name
          active
        }
      }
    }
  }
}
```

## Common Filters

* `eventNameContains` - Search by event name substring
* `eventName` - Find by exact event name
* `start` - Filter by whether signal starts workflow
* `workflowID` - Filter by associated workflow
* `dataTypeSlug` - Filter by data type slug
* `hasWorkflow` - Filter signals that have associated workflow
* `hasWorkflowWith` - Filter by workflow criteria
* `tenantID` - 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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/queries/workflowsignals.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.