Blocks Deprecated
Deprecated: use the web blocks for new pages This block belongs to state pages and UI components. Existing pages keep running, but new pages should use the web blocks. See Web Pages and the migration guide.

backend request

This block is part of the state ui group and was last modified in core v14.0.1.

API Selection Required

This block relies on a API to perform its API releated actions. You must manually select the API you want to use in your flow using the API selector modal. To access the modal, click the white button on the block.

backend request v14.0.1

Requests the backend for data that can be used in the state flow

In pins 6
  • state state required v14.0.1
  • State Key value required v14.0.1

    The state key to update with the response of the API

  • parameters object v14.0.1
  • query object v14.0.1
  • Show Loader condition v14.0.1

    Providing true will hide chaining content with a loader

    Default false

  • Use WebSocket condition v14.0.1

    Providing true forces the request over a websocket, allowing for broadcasting capabilities like listening on messages. By default the request will be made using the Fetch API. All requests are always made using the local users access_token if any is present.

    Default false

Out pins 1
  • state state

    Returns the element to the frontend state.

request

A typical wiring for backend request: value feeds the state_key pin; the state out pin feeds get component child.

Studio canvas example for the backend request block: typical wiring for backend request.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v14.0.1.


Back to state ui Return to the main group to view all sub-groups Back to state actions Return to the group to view all blocks within this group