The block catalog

​

Every block you can place in a diagram: its params and rules, outputs, defaults, the plan tier it needs and the channels it runs on.

A block whose behaviour changes with a param is described as variants; selector says which params pick each.

The catalogue grows a family at a time, so a diagram may hold blocks it does not cover.

Query Parameters

  • channel_family
    Type: enum

    Restrict to blocks available on a channel family. Not served yet: it is accepted and ignored, and the whole catalog comes back.

    values
    landbotwhatsappfacebookapichat

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/blocks
curl 'https://api.landbot.io/v0-alpha/blocks?channel_family=landbot' \
  --header 'Authorization: Token YOUR_AGENT_TOKEN'

{
  "data": [
    {
      "name": "ask_email",
      "title": "string",
      "description": "string",
      "can_be_welcome": true,
      "variants": [
        {
          "selector": [
            {
              "param": "string",
              "match": "equals",
              "matches_null": true,
              "value": null,
              "field": null
            }
          ],
          "params": [
            {
              "name": "string",
              "type": "string",
              "required": true,
              "has_default": true,
              "title": "string",
              "description": "string",
              "default": null,
              "rules": [
                {
                  "name": "non_empty",
                  "constraint": "^[a-z]+$"
                }
              ],
              "item": {
                "type": "string",
                "rules": [
                  {
                    "name": "non_empty",
                    "constraint": "^[a-z]+$"
                  }
                ],
                "fields": [],
                "item": null,
                "one_of": []
              },
              "fields": [],
              "one_of": [],
              "read_when": [
                {
                  "param": "string",
                  "match": "equals",
                  "matches_null": true,
                  "value": null,
                  "field": null
                }
              ]
            }
          ],
          "outputs": [
            {
              "id": "$success",
              "title": "string"
            }
          ],
          "output_derivations": [
            {
              "param": "string",
              "id_field": "string",
              "id_prefix": "string",
              "title_field": "string"
            }
          ],
          "param_derivations": [
            {
              "kind": "compiled_formula",
              "param": "string",
              "source": "string"
            }
          ],
          "required_tier": "sandbox",
          "channel_restriction": [
            "landbot"
          ],
          "answer": "email",
          "interaction": "waits_for_input"
        }
      ]
    }
  ]
}

The catalog