You are reading the documentation for an outdated Corteza release. 2023.9 is the latest stable Corteza release.

Corredor helpers

Corredor helpers implement the most common operations, such as creating records and sending emails.

Corredor helpers come pre-configured in the execution context.

Corredor helpers are context-aware, meaning that they can automatically determine the base parameters required by the operation. For example, when creating a record, Corredor helpers will know what namespace, module, and record you are using.

You can use Corredor helpers outside automation scripts.

You can find the source code on GitHub/cortezaproject/corteza-js. NPM packages can be found on NPM/@cortezaproject/corteza-js.

Make sure to use the same @cortezaproject/corteza-js package version as your Corteza instance.

When using our corteza-js package, the API clients can be imported using import { corredor } from '@cortezaproject/corteza-js'.

Available Corteza Corredor helpers:

DevNote take note of the compose-ui helper.