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

# twin

Reference for the twin variable in action placeholders and conditions.

{% hint style="info" %}
This page describes the `twin` variable: the object this action created in the target system, one of the variables you can use in `{{ }}` placeholders and conditions when you customize an action's YAML definition. It is available in `steps`, not in templated settings (such as a webhook body) (such as a webhook body) or `inbound`. Start with [Actions → The 'steps' section](https://docs.ilert.com/integrations/actions.md#the-steps-section) for how the definition works.
{% endhint %}

Root `twin` (outbound only): the object this action created for this alert or incident in the target system. Absent (never null) until a `CREATE` step's `referenceWrite` has run, so `twin == nil` marks the first run. One twin per action and alert or incident.

```yaml
openapi: 3.1.0
info:
  title: ilert action context - twin
  version: 1.0.0
  description: >-
    Root `twin` (outbound only): the object this action created for this
    alert or incident in the target system. Absent (never null) until a
    `CREATE` step's `referenceWrite` has run, so `twin == nil` marks the first
    run. One twin per action and alert or incident.
components:
  schemas:
    Twin:
      type: object
      required: [id, externalId, externalSystem, status, ref]
      properties:
        id:
          type: integer
          description: Internal twin id.
        externalId:
          type: string
          description: The object's id in the target system, from `referenceWrite.externalId`.
        externalUrl:
          type: [string, 'null']
          description: Link to the object, from `referenceWrite.externalUrl`.
        externalSystem:
          type: string
          description: The template's brand, for example `jira`.
        status:
          type: string
          enum: [ACTIVE, TERMINAL]
        ref:
          type: object
          additionalProperties: true
          description: The values written by `referenceWrite.ref`.
          examples:
            - issueId: "10042"
              issueKey: OPS-17
```


---

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