> For the complete documentation index, see [llms.txt](https://docs.ilert.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ilert.com/integrations/actions/context/signal.md).

# signal

Reference for the signal variable in action placeholders and conditions.

{% hint style="info" %}
This page describes the `signal` variable: the event that started the run, one of the variables you can use in `{{ }}` placeholders and conditions when you customize an action's YAML definition. It is available in `steps` and in templated settings (such as a webhook body), not in `inbound`. Start with [Actions → Custom behavior](https://docs.ilert.com/integrations/actions.md#custom-behavior-advanced-topic) for how the definition works.
{% endhint %}

Root `signal` (outbound only): the event that started this run. Always present. The alert or incident itself is the separate `entity` root, and the user who made the change is the separate `actor` root.

```yaml
openapi: 3.1.0
info:
  title: ilert action context - signal
  version: 1.0.0
  description: >-
    Root `signal` (outbound only): the event that started this run. Always
    present. The alert or incident itself is the separate `entity` root, and
    the user who made the change is the separate `actor` root.
components:
  schemas:
    Signal:
      type: object
      required: [type, occurredAt, tenantId, version, dispatch]
      properties:
        type:
          $ref: '#/components/schemas/SignalType'
        occurredAt:
          type: string
          format: date-time
          description: When the change happened in ilert (ISO-8601).
        tenantId:
          type: string
          description: Your ilert account id.
        version:
          type: integer
          description: Signal schema version. Currently `1`.
        dispatch:
          type: string
          enum: [AUTOMATIC, MANUAL]
          description: >-
            `MANUAL` when a responder started the action with Run or Run again,
            `AUTOMATIC` otherwise.
        correlationId:
          type: string
          description: >-
            Id of the signal, shared by every action it triggers. Use
            `execution.correlationId` for the id of this run.
        delayedBySec:
          type: integer
          description: Present only on delayed events, the configured delay in seconds.
        origin:
          type: object
          description: >-
            Where the change came from. Present only on `alert.comment_added`
            and `incident.comment_added`, and only when the comment was written
            by an integration, for example a Jira comment synced back through a
            callback. Absent for comments written in ilert. Use it to avoid
            posting a comment back to the system it came from:
            `signal.origin.system != 'jira'`.
          required: [kind, system]
          properties:
            kind:
              const: INTEGRATION
              description: Always `INTEGRATION`.
            system:
              type: string
              description: >-
                The integration that wrote the comment. For action callbacks
                this is the template's brand in lowercase, for example `jira`.
                Comments written from ChatOps carry `SLACK`, `MS_TEAMS` (alerts),
                `MSTEAMS` (incidents) or `GOOGLECHAT`. The comparison is
                case-sensitive.
              examples: [jira, github, SLACK]

    SignalType:
      type: string
      description: >-
        `alert.*` types reach alert actions, `incident.*` types reach incident
        actions. `*.not_resolved` and a delayed `alert.escalation_ended` are
        raised by a timer.
      enum:
        - alert.created
        - alert.accepted
        - alert.resolved
        - alert.rerouted
        - alert.escalated
        - alert.escalation_ended
        - alert.priority_raised
        - alert.responder_added
        - alert.responder_removed
        - alert.comment_added
        - alert.channel_attached
        - alert.channel_detached
        - alert.not_resolved
        - incident.opened
        - incident.updated
        - incident.status_changed
        - incident.resolved
        - incident.deleted
        - incident.responder_added
        - incident.responder_removed
        - incident.responder_updated
        - incident.comment_added
        - incident.channel_attached
        - incident.channel_detached
        - incident.postmortem_linked
        - incident.not_resolved
```


---

# 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.ilert.com/integrations/actions/context/signal.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.
