BlockVariant

  • Channel families this variant is valid on. Empty means every one of them. Put it in a bot of any other family and the diagram breaks block_not_on_channel.

  • Whether the block pauses the conversation waiting for the user. This is what makes a cycle in the diagram legitimate or not: a loop through blocks that never wait is an error.

    values
    waits_for_inputruns_without_input
  • Whether the block runs a diagram of its own, the brick the document keeps in bricks under the block's id. True for brick alone. Such a block also has the outputs its diagram's outputs node lists, on top of outputs, it asks for the highest tier of the blocks inside it, and it waits for the user when one of them does.

  • Rules the caller runs over its own params to know the outputs this variant reports for them, on top of the fixed outputs — a button block reports one output per button. Empty when every output is fixed.

    Properties: 5
  • The fixed outputs a connection can leave from, as used in a connection's type.

    Properties: 2
  • Params this variant works out itself rather than the caller writing them, and the param each one is worked out from. What a caller sends for a derived param is replaced or kept according to the derivation's kind. Empty when every param is the caller's. Applied when a block is added or edited, and not by PUT /bots/{bot_id}/draft, which stores what it is given.

    Properties: 4
  • Properties: 12
  • A subscription tier, ordered from lowest to highest.

    values
    sandboxstarterprofessionalbusiness
  • The conditions over a block's own params that select this variant. Empty on a single-variant block, which any params select.

    Properties: 5
  • What kind of answer the block collects, for the blocks that ask for one. Absent on a block that asks for nothing.

    values
    emailphoneurlnumberdatefile