API reference
Choose the current native reference
These links open the current implementation reference directly, regardless of the language currently selected in the navigation. For an older installed release, choose its matching documentation version first. Avoid copying constructor names from another language or from a frozen versioned page.
Use the recipe index to find forms, response URLs, helpers and SDK
handoff before reading implementation source. For example, PHP
RichTextUserGroup names its constructor
argument userGroupId; the Slack wire key is usergroup_id. The generated native
reference gives the callable spelling and parameter types.
References in a source checkout
Most current reference pages are generated during the documentation build and
intentionally ignored by Git. Their absence from a fresh checkout does not mean
the public type is undocumented. Install the documented development toolchains,
then run pnpm --filter @slackblocks/docs generate to create the references or
pnpm --filter @slackblocks/docs build to generate and verify the complete site.
The build reads the native public APIs; do not copy an older versioned reference
into the current tree or hand-edit generated signatures. See the
maintenance guide for generation and release checks.
Looking for the exact class or constructor argument to use? The Python API reference covers every public class, function, signature, and docstring in the package. Start with the category that matches the payload you are building, then follow the linked types as you go.
Need the precise setter or returned payload type? The TypeScript API reference brings together every fluent builder, component, type, and validation error. Use it when you know what you want to build and need the exact TypeScript contract.
Need the exact constructor, fluent method, JSON type, or validation category? The Go API reference documents the full module, including all Block Kit builders, payloads, views, and higher-level components.
Need the exact builder method, immutable return type, or validation category? The Java API reference documents every public concrete builder, Block Kit value, payload, component, and exception, including its parameters and direct Slack Java SDK interoperability.
Need the exact constructor parameter, property type, or validation category? The C# API reference documents every public Block Kit value, role interface, payload, component, and exception, including each constructor's parameters and the limits they enforce.
The Ruby API reference documents keyword constructors, immutable readers, RBS signatures, validation errors, and serialization methods for every public value and component.
The Rust API reference covers every public value, consuming
builder, role enum, helper and structured error. Signatures and comments are
read from the actual Rust syntax; generated naming follows the shared model.
Run cargo doc --manifest-path rust/Cargo.toml --no-deps for native rustdoc,
including Serde and conversion trait implementations.
The PHP API reference covers every public class, interface, enum, constructor, property and helper. Signatures, defaults and PHPDoc are reflected from the actual library, including the inherited checked JSON and editing methods on Value.
The Elixir API reference covers every public module, struct field, constructor, editing function, helper and typespec. Documentation and signatures come from compiled Elixir metadata, including functions with default arguments. HexDocs will become available after the first release.
The Haskell reference combines GHC-discovered signatures with compiled Haddock comments. It includes every public model, field record, constructor, role conversion, matcher, helper and structured error. The build compares those exports with the independent API inventory and checks rendered anchors. Native Haddock is also built from the actual source archive.