Skip to content

TextMessage ​

Type: object additionalProperties: false

FieldRequiredTypeDescription and constraints
external_keyNostringExternal message or event key; not unique and not sent to the harness. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization. minLength: 1
maxLength: 512
textYesstringminLength: 1
metadataNoobjectOpaque integration data retained with the message, never sent to the agent. If present, must be a JSON object. additionalProperties: true

JSON Schema ​

json
{
  "additionalProperties": false,
  "properties": {
    "external_key": {
      "description": "External message or event key; not unique and not sent to the harness. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.",
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    },
    "text": {
      "minLength": 1,
      "title": "Text",
      "type": "string"
    },
    "metadata": {
      "description": "Opaque integration data retained with the message, never sent to the agent. If present, must be a JSON object.",
      "type": "object",
      "additionalProperties": true,
      "x-go-type": "json.RawMessage"
    }
  },
  "required": [
    "text"
  ],
  "title": "TextMessage",
  "type": "object"
}

All schemas · HTTP API