> 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/types/workflowsignal.md).

# 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

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


---

# 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/types/workflowsignal.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.