Block Quick Reference

The 50 blocks that cover 95% of daily work — what each does, and where to read more. Use ⌘K to search this table.

Pages & UI

BlockDoes what
state_pageRegisters a page URL and starts the page flow.
state_render_pageSends the assembled HTML to the browser.
state_h1 / text elementsHeadings, text, containers on the page.
state_formForm container element.
state_input_dynamicTyped input field inside a form.
state_buttonButton with a click event.
state_form_getReads the submitted form (form-object, form-error).
state_advanced_datatablePre-styled table fed from a storage.

APIs & HTTP

BlockDoes what
on_startup_register_uri_getRegisters GET /api/v1/<uri>.
on_startup_register_uri_postRegisters POST /api/v1/<uri> (webhooks, creates).
httpconnection_current_requestThe live request connection object.
httpconnection_get_paramsReads query parameters of the current request.
httpconnection_set_jsonReplies to the caller with JSON + status code.
http request (http connection group)Calls external APIs.

Storage & Queries

BlockDoes what
storageSelects the storage collection for connected blocks.
function_searchSearches documents (query, limit, offset, cache key).
function_search_single_resultSearches and returns the first hit only.
function_get_documentReads one document by guid.
function_create_document_from_mutationsCreates a document from a mutation set.
function_update_document_mutationsApplies mutations to an existing document.
function_remove_document / function_delete_documentSoft-deletes (recoverable) / hard-deletes.
mutations_set_bp_field_multipleSets several document fields at once.
mutations_set_custom_fieldSets one field with a custom value.
mutations_increment_by_fieldAtomically increments/decrements a number.
query_and / query_bool_mustCombines query parts (AND / multi-term OR).
query_bool_term_fieldsExact match on one field.
query_bool_filterAttaches filter clauses.
query_bool_simple_query_string_fieldFree-text match on a field.
query_bool_range_fieldDate/number range on a field.
query_sort_fieldSorts results by a field.

Data & Logic

BlockDoes what
value_default / number_defaultA fixed text / number value.
object_new_fieldsBuilds an object with named fields.
object_update_fieldsAdds/changes fields on an existing object.
array_mapTransforms every item in an array.
branchSplits flow into true/false paths on a condition.
condition_not_empty_valueTrue when the checked value is filled.
function_console_logWrites to the blueprint console.
trigger_custom_functionDefines/calls a reusable function.
function_returnReturns values from a function.

Background & Scheduling

BlockDoes what
function_custom_execute_from_queueDefers work to the queue (heavy jobs, retries).
schedule_repeating_eventFires a flow on a schedule.
storage_eventFires on document create/update/save/remove.
function_redis_cache_delete_keyDeletes a Redis cache key (invalidation).
user_currentThe calling user's document.

Next Steps

All Blocks The full 1,600+ block library by group. Block Templates These blocks wired into working combinations. Finding Blocks Search techniques and starter sets.