---
title: "backend request · RUAL Documentation"
description: "Requests the backend for data that can be used in the state flow"
canonical: https://docs.rual.nl/block-types/state%20ui/state_backend_request
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# backend request

This block is part of the [`state ui`](https://docs.rual.nl/block-types/state%20ui) group and was last modified in core [`v14.0.1`](https://docs.rual.nl/core-versions/140001).

## 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.

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

- state required `v14.0.1` `state`

- State Key required `v14.0.1` `value` The state key to update with the response of the API

- parameters `v14.0.1` `object`

- query `v14.0.1` `object`

- Show Loader `v14.0.1` `condition` Providing `true` will hide chaining content with a loader

Default `false`

- Use WebSocket `v14.0.1` `condition` 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`

- state `state` Returns the element to the frontend state.

| `request` |
| --- |

A typical wiring for [backend request](https://docs.rual.nl/block-types/state%2520ui/state_backend_request): [value](https://docs.rual.nl/block-types/value/value_default) feeds the `state_key` pin; the `state` out pin feeds [get component child](https://docs.rual.nl/block-types/state%2520actions/state_component_get_child).

[![Studio canvas example for the backend request block: typical wiring for backend request.](https://docs.rual.nl/canvas-examples/state_backend_request.png)](https://docs.rual.nl/canvas-examples/state_backend_request.png?v=3)

## Version history

Introduced in [`v14.0.1`](https://docs.rual.nl/core-versions/140001).

- [Back to `state ui`](https://docs.rual.nl/block-types/state%20ui): Return to the main group to view all sub-groups

- [Back to `state actions`](https://docs.rual.nl/block-types/state%20ui?group=state%20actions): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)