For the complete documentation index, see llms.txt. This page is also available as Markdown.

payload

Reference for the payload variable in action placeholders and conditions.

This page describes the payload variable: the callback body the target system sent, one of the variables you can use in {{ }} placeholders and conditions when you customize an action's YAML definition. It is available only in the inbound section. Start with Actions → The 'inbound' section for how the definition works.

Root payload (inbound only): the callback body the target system sent to the Callback URL. Always present. Request headers are not exposed.

openapi: 3.1.0
info:
  title: ilert action context - payload
  version: 1.0.0
  description: >-
    Root `payload` (inbound only): the callback body the target system sent to
    the Callback URL. Always present. Request headers are not exposed.
components:
  schemas:
    Payload:
      description: >-
        Parsed JSON when the body is JSON, otherwise the raw text; `{}` when
        the body is empty. Its shape is defined by the target system.
      examples:
        - webhookEvent: comment_created
          issue: { id: "10042" }
          comment: { id: "20001", body: Looking into it }

Last updated

Was this helpful?