ActionInput

A single input field on an action instance. The caller wires this field up via the Configure Action endpoint.

Properties

namestringrequired

Input field identifier (the template's `payloadStructureId`, lowercased).

typestringrequired

Field type (e.g. `string`, `url`, `email`, `number`, `boolean`, `promptField`, `stepDownSearch`).

requiredbooleanrequired

Whether this field must be configured before the action can run.

descriptionstring

Human-readable description of what this field accepts.

Example

ActionInput example
{
  "name": "linkedin_url",
  "type": "url",
  "required": false,
  "description": "LinkedIn profile URL of the person"
}