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

# entity

Reference for the entity variable in action placeholders and conditions.

{% hint style="info" %}
This page describes the `entity` variable: the alert or incident the action runs on, 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 `entity` (outbound only): the alert or incident the action runs on, as it is after the change. Always present. Fields without a value are left out, never null, so test them with `!= nil`. Event-specific fields are only present on automatic runs of that event type.

Uses: [Context schema: entity (alert)](https://docs.ilert.com/integrations/actions/context/entity-alert.md), [Context schema: entity (incident)](https://docs.ilert.com/integrations/actions/context/entity-incident.md).

```yaml
openapi: 3.1.0
info:
  title: ilert action context - entity
  version: 1.0.0
  description: >-
    Root `entity` (outbound only): the alert or incident the action runs on,
    as it is after the change. Always present. Fields without a value are
    left out, never null, so test them with `!= nil`. Event-specific fields
    are only present on automatic runs of that event type.
components:
  schemas:
    Entity:
      oneOf:
        - $ref: './entity-alert.md#/components/schemas/AlertEntity'
        - $ref: './entity-incident.md#/components/schemas/IncidentEntity'
      discriminator:
        propertyName: kind
        mapping:
          ALERT: './entity-alert.yaml#/components/schemas/AlertEntity'
          INCIDENT: './entity-incident.yaml#/components/schemas/IncidentEntity'

    IdName:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string

    User:
      type: object
      properties:
        id:
          type: integer
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        name:
          type: string
          description: Display name.
```


---

# 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/entity.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.
