InteractionMessageStartConfig

An automation action ($type is interaction-message) that posts a message into a running interaction, for example to wake it or move it on when something happens. It starts no new run.

Kind: an object, used in requests and responses. In a request it is called InteractionMessageStartConfigInput.

In a request

Field	Type	Required	Description
interactionProcessId	uuid | null		The id of the interaction run to post to. Give this or interactionProcessIdFromEvent.
interactionProcessIdFromEvent	string | null		A JSONPath expression that picks the interaction run’s id out of the change that fired a message trigger, such as $.item.id. Give this or interactionProcessId. It cannot be used with a manual trigger.
message	string	yes	The message to post. Constraints: required (empty or whitespace-only strings are rejected).
senderType	string		The author name the message is recorded under. System by default.
version	VersionReference| null		The app, interaction or capsule to start, and the version of it. Required for those three; left out for codepipeline (named by name) and interaction-message (which names a run).

{
  "interactionProcessId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "interactionProcessIdFromEvent": "...",
  "message": "...",
  "senderType": "...",
  "version": {
    "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "version": 0
  }
}

In a response

Every field is present in a response; empty ones are null.

Field	Type	Description
interactionProcessId	uuid | null	The id of the interaction run to post to. Give this or interactionProcessIdFromEvent.
interactionProcessIdFromEvent	string | null	A JSONPath expression that picks the interaction run’s id out of the change that fired a message trigger, such as $.item.id. Give this or interactionProcessId. It cannot be used with a manual trigger.
message	string	The message to post. Constraints: required (empty or whitespace-only strings are rejected).
senderType	string	The author name the message is recorded under. System by default.
version	VersionReference| null	The app, interaction or capsule to start, and the version of it. Required for those three; left out for codepipeline (named by name) and interaction-message (which names a run).

{
  "interactionProcessId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "interactionProcessIdFromEvent": "...",
  "message": "...",
  "senderType": "...",
  "version": {
    "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "version": 0
  }
}

Where it’s used

• Inside ProcessStartConfig