< woml />
View on GitHub

<props> and <prop>

<props> contains the <prop> declarations that form a reusable step or notification provider's public interface.

Why use it

Use props to make reusable definitions explicit and statically checkable. Secret props also ensure callers pass symbolic secret references instead of ordinary values.

Common use cases

  • Require input for a reusable step.
  • Expose optional reusable configuration.
  • Require a secret reference for a provider credential.

Syntax

WOML
<props>
  <prop name="price" required="true" />
  <prop name="api-token" required="true" secret="true" />
</props>

Rules and behavior

  • Props are valid only in reusable definition files and sit outside the top-level reusable step or provider.
  • name uses kebab-case and is exposed as lower camel case under props.
  • required and secret are optional boolean declarations.
  • A secret prop requires an exact {{secrets.NAME}} invocation value.