Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude
API/schemas
Schema

NotifyStepDefinition

Notify step — sends a notification (Slack, Teams, email) without dispatching a tool. Stuart 2026-05-19: 1 template on dev uses ``type='notify'`` (the FIC reconciliation step); same schema-gap fix as archie_query.

FieldTypeDescription
idrequiredstring—
namerequiredstring—
typestring—
descriptionstring | null—
depends_onstring | object[]—
stagestring | null—
timeoutstring | null—
retry_policyRetryPolicy | null—
error_handlerStepErrorHandler | null—
impact_level"low" | "medium" | "high" | "critical"Impact classification for steps.
lowmediumhighcritical
run_mode"propose" | "auto_run"Execution mode for steps.
proposeauto_run
requires_approvalboolean—
metadataobject | null—
examplesStepExample[] | nullAttached example files for this step. Each entry pairs a platform.file_uploads.file_id with a role + tags + notes so the runtime can shape its instruction. Bounded at 20 to keep a reasonable upper limit on the prompt preamble.
tagsstring[] | nullCategorical labels on the step itself (e.g. 'pdf-read', 'coutts', 'fy25'). Free-form; recommended tag set is documented per workstream surface.
channelrequiredstringNotification channel slug (e.g. 'slack:#close-team', 'email:[email protected]').
messagerequiredstringMessage body — supports {{ outputs.* }} Jinja2 placeholders.
inputsobject | nullOptional Jinja2 input bindings.