InteractionProcessStartConfig

An automation action ($type is interaction) that starts an interaction run. version names the interaction and the version of it to start, and is required.

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

In a request

Field	Type	Required	Description
initialPrompt	string | null		A first message to post into the run once it has started, recorded as from System. Optional.
inputs	NameValuePair[]		A value for each of the interaction’s inputs, by name.
durationAutoTerminationOverride	timespan | null		Replaces the interaction’s maximum run time for the runs this starts. Null: the interaction’s own limit.
durationWarningOverride	timespan | null		Replaces when the interaction’s agents are warned that time is running out, for the runs this starts. Null: the interaction’s own setting.
swarmLimits	InteractionSwarmLimitsRequestInput| null		Narrows how far the sub-interactions of each run this starts may spread, as swarmLimits does on an interaction start request. Null: the interaction’s own limits.
credentialStack	string | null		The credential stack (id or name) the runs this starts use, as credentialStack does on an interaction start request. Null: the interaction’s own stack, else its namespace’s default, else the tenant’s.
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).

{
  "initialPrompt": "...",
  "inputs": [
    {
      "name": "...",
      "value": "..."
    }
  ],
  "durationAutoTerminationOverride": "00:05:00",
  "durationWarningOverride": "00:05:00",
  "swarmLimits": {
    "maxDepth": 0,
    "maxConcurrent": 0,
    "maxTotal": 0
  },
  "credentialStack": "...",
  "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
initialPrompt	string | null	A first message to post into the run once it has started, recorded as from System. Optional.
inputs	NameValuePair[]	A value for each of the interaction’s inputs, by name.
durationAutoTerminationOverride	timespan | null	Replaces the interaction’s maximum run time for the runs this starts. Null: the interaction’s own limit.
durationWarningOverride	timespan | null	Replaces when the interaction’s agents are warned that time is running out, for the runs this starts. Null: the interaction’s own setting.
swarmLimits	InteractionSwarmLimitsRequest| null	Narrows how far the sub-interactions of each run this starts may spread, as swarmLimits does on an interaction start request. Null: the interaction’s own limits.
credentialStack	string | null	The credential stack (id or name) the runs this starts use, as credentialStack does on an interaction start request. Null: the interaction’s own stack, else its namespace’s default, else the tenant’s.
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).

{
  "initialPrompt": "...",
  "inputs": [
    {
      "name": "...",
      "value": "..."
    }
  ],
  "durationAutoTerminationOverride": "00:05:00",
  "durationWarningOverride": "00:05:00",
  "swarmLimits": {
    "maxDepth": 0,
    "maxConcurrent": 0,
    "maxTotal": 0
  },
  "credentialStack": "...",
  "version": {
    "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "version": 0
  }
}

Where it’s used

• Inside ProcessStartConfig