Configuring blocks

The Slack block sends a Slack message to a given channel.

Prerequisites

Before configuring a Slack block:

• Make sure the Cortex Slack Bot is added to the channel you want to send messages to via the Workflow.

• Make sure the Slack Bot has the chat:write.public permission scope enabled.

Configure a Slack block

To configure a Slack block:

1. Click Slack from the list of blocks.

2. Enter a name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Under Channel name, select a channel.

   • The channels listed in the dropdown are pulled from your organization's integration with Slack.

4. Under Message text, enter the message that will be sent in Slack via this block.

   • You can enter a simple string or use templating for a more dynamic message. For example, you can templatize to include the email address of the person who initiated the Workflow, reference prior blocks, or reference outputs.

5. Click Save.

A Branch allows you to set up to five conditional paths for a Workflow.

Configure a branch

To configure a branch:

1. Click Branch from the list of blocks.

2. On the right side of the page, enter a Block name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Click +Add Path.

4. On the right side of the page, the "Conditional paths" section will expand. Enter a name, a slug, and a path expression.

   • The path expression is compatible with CEL syntax. The path expression does not accept dashed values; if you reference a block's slug that contains a dash, wrap the slug in quotes and square brackets.

     • For example, if you want to reference a block with the slug slug-example, the expression would begin with actions["slug-example"].

     • Note: Autocomplete will provide correctly formatted options based on the blocks defined in your Workflow.

5. Under the Path expression text box, click Save.

   • You will be redirected to the block editor page, showing your newly-added path in the Workflow visual.

6. Optionally, add additional paths and a fallback path.

   • Click + under a path to add the next type of block. You can add any type, including another branch.

7. When you are finished adding paths, click Save at the bottom of the block editor.

8. If you want to add additional blocks that occur after the paths within your branch, click + below the branch box in the Workflow editor.

How paths work

The paths defined run sequentially. The first path that returns true will execute, even if subsequent paths would also return true. The Workflow will then continue performing blocks in that path. You can also set a fallback path that will run if all other paths fail.

Primary and nested branches function the same way.

Nested branches

To nest a branch:

1. In the visual Workflow, click the + that is branched off your original branch.

2. On the right side of the page in the Workflow editor, select Branch.

3. Enter a name for your branch, then click Save.

There are no limits on how many branches you can nest.

A Data transformation performs data transformations using jq. Except for the block name and slug, the only field required is the jq expression.

Configure a data transformation

To configure a data transformation:

1. Click Data transformation from the list of blocks.

2. Enter a name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Enter a jq expression. This field can pass any sort of jq expression, as long as the variables and context are referenced differently.

   • Although you would typically use {} to template the context of your Workflow, in this field you’ll need to reference such values as jq query values.

4. Click Save.

The HTTP request makes and records a request to a given URL, allowing you to integrate with external APIs or internal systems.

For use cases requiring asynchronous operations (e.g., provisioning cloud resources, CI/CD pipelines), use the HTTP async action.

Configure an HTTP request

To configure an HTTP request:

1. Click HTTP request from the list of blocks.

2. Enter a name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Select an HTTP method. The options are DELETE, GET, PATCH, POST, or PUT.

4. Configure the fields:

   • URL: Enter a static URL or use a template to reference other blocks.

     • If you use {{actions.url.outputs.result}}, for example, you can set the URL to the output of a jq action. In this example:

       • .actions indicates a reference to a Workflow block

       • .url is the slug for the Workflow block we’re referencing

       • .outputs is the location of the actual output of the jq expression

       • .result is the result field where the output is stored

     • Because Mustache performs HTML escaping by default, special characters referenced in a value with two curly braces ({{}}) will be converted to their associated HTML encoding. For example, {{=}} would become &#61. To reference a non-escaped value, use three curly braces ({{{=}}}).

   • Headers: Click one of the options provided, or enter your own.

     • When using a secret with a header, prefix the secret with context..

   • Payload: This field appears if you are using an HTTP request that sends a payload. The payload that you supply can also be templated and can reference an entity that the Workflow is being run with. Some additional steps are required to properly template raw JSON in the payload field:

     • Single primitive values will work as expected. To add JSON objects or arrays, create a Data Transformation block that accesses the relevant JSON and pipes it into the tojson built-in.

       • For example, .context.initiatedBy | tojson would enable a user to add the full initiatedBy object () into an HTTP request payload. When templating this value, three curly braces are needed in order to reference a non-escaped value. Continuing our earlier example, if the Data Transformation block we just created has the slug transform-to-json, then the payload would include {{{actions.transform-to-json.outputs.result}}}.

5. Click Save.

The HTTP async request makes and records a request to a given URL. This block will pause execution until a callback API is invoked or a timeout occurs, enabling long-running Workflows.

Configure an HTTP async request

1. Click HTTP action (async) from the list of blocks.

2. Enter a name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Select an HTTP method. The options are DELETE, GET, PATCH, POST, or PUT.

4. Configure the fields:

   • URL: Enter a static URL or use a template to reference other blocks.

     • If you use {{actions.url.outputs.result}}, for example, you can set the URL to the output of a jq action. In this example:

       • .actions indicates a reference to a Workflow block

       • .url is the slug for the Workflow block we’re referencing

       • .outputs is the location of the actual output of the jq expression

       • .result is the result field where the output is stored

     • Because Mustache performs HTML escaping by default, special characters referenced in a value with two curly braces ({{}}) will be converted to their associated HTML encoding. For example, {{=}} would become &#61. To reference a non-escaped value, use three curly braces ({{{=}}}).

   • Headers:

     • Include an Authorization header and use a personal access token.

     • Optionally include additional headers: Click one of the provided headers, or enter your own.

     • When using a secret with a header, prefix the secret with context..

   • Payload: This field appears if you are using an HTTP request that sends a payload. The payload that you supply can also be templated and can reference an entity that the Workflow is being run with. Some additional steps are required to properly template raw JSON in the payload field.

     • Single primitive values will work as expected, but to add JSON objects or arrays, follow these steps you first need to create a Data Transformation action that accesses the relevant JSON and pipes it into the tojson built-in.

     • For example, .context.initiatedBy | tojson would enable a user to add the full initiatedBy object () into an HTTP request payload. When templating this value, three curly braces are needed in order to reference a non-escaped value. Continuing our earlier example, if the data transformation action we just created has the slug transform-to-json, then the payload would include {{{actions.transform-to-json.outputs.result}}}.

   • Timeout: Configure a timeout for this action. The maximum is 30 days and the minimum is 1 minute.

     • After a timeout, the block will fail with the status timed_out. If you have notifications enabled, you will receive a notification if you initiate a Workflow and it times out.

5. Click Save.

Handling the callback

Once the HTTP Async Request block runs, Cortex sends the configured request and pauses the Workflow. To resume execution, the external system must call the callback URL provided by Cortex and follow the required schema.

The callback request must:

• Use the POST method

• Include a valid Cortex API key in the Authorization header (Bearer <token>)

• Match the expected request body shape. Below is an example:

{
  "message": "Provisioning complete – sandbox environment created.",
  "response": {
    "env_id": "sandbox-abc123"
  },
  "status": "SUCCESS"
}

See the full Cortex API reference for callback details and status options (SUCCESS, FAILURE, CANCELLED).

Configure a JavaScript block

Use a JavaScript block to insert custom code or add looping and other logic to your Workflows.

The JavaScript runtime supports the ES2020 specification and has an implementation of Fetch API, allowing you to make HTTP requests directly in the script rather than needing to add an additional HTTP request block to your Workflow.

To test your block's code locally, you can use Cortex's JavaScript harness.

1. Click JavaScript from the list of blocks.

2. On the right side of the page, configure the fields:

   • Block name: Enter a descriptive name for your block.

   • Slug: The slug field will automatically pre-populate based on the name you enter.

   • JavaScript: Enter the script you want to run. The script must end with a return statement. The value from the return statement is exposed via outputs.result.

     • For example, in the script return {"a": 1, "b": 2}, the result can be referenced from subsequent blocks as actions.<SLUG>.outputs.a.

     • You can reference previous blocks and run context by accessing actions and context. For example, actions["jq"].outputs.result.

       • Learn more about referencing blocks and Workflow states here.

     • If you want the block to fail, you can use the throw statement. For example:

       Copy

       let previous = actions.previous.outputs.result;
       if (previous == null) {
         throw "Some error";
       }

3. Click Save.

A Manual approval pauses the Workflow to get approval from a member of a given Team. Like with user inputs, the Workflow will proceed to the next block once it has been approved.

Configure a manual approval

To configure a manual approval:

1. Click Manual approval from the list of blocks.

2. Enter a name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Under Teams allowed to approve, select one or more teams who are allowed to approve the request from this block. Any member of a given team can approve the block.

4. Click Save.

You can have multiple manual approvals within a given Workflow. If you have two blocks with two different sets of teams set as approvers, each team will only be able to approve the block they are defined under.

Pending approval

When a manual approval block is triggered, users that belong to teams designated as approvers will see Pending approvals at the top of their Workflows page.

This section displays any blocks that are pending your approval. If manual approval actions exist within a Workflow, but do not require your approval, they will not appear here, even if you are designated to approve a different block in the same Workflow.

You can open any Workflow in the pending approval list to Approve or Reject the block.

Once all of your approval requests have been approved or rejected, this tab will disappear from the Workflows page.

The Scaffolder uses a Cortex Scaffolder template to perform a given function. You must have the Execute Scaffolder permission to configure a Scaffolder block.

See the docs to learn about registering a Scaffolder template.

To configure a Scaffolder:

1. Click Scaffolder from the list of blocks.

2. Enter a name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Under Scaffolder template, select a template from the dropdown.

   • This dropdown pulls in all templates available from the Scaffolder page.

4. Configure the remaining fields. The fields differ depending on the template's specifications and available Git providers. The option to create a repo also may or may not be visible, depending on whether the template requires a pull request.

5. Click Save.

Define Scaffolder template overrides

You can also define Scaffolder template overrides for a block — these will override template fields with output variables from a previous Workflow step, or from the context of the Workflow.

To add an override:

1. In the bottom of the block configuration, click Add variable.

2. In the override variable modal, click the Variable dropdown to select the Scaffolder template fields to override. Note that the options in this dropdown will be pulled from fields in the Scaffolder template you selected in the first step.

3. Under Path, enter the path to the actual value we want in the Workflow.

   • For example, if you wanted to override the Project name variable for a Scaffolder with the tag of the entity you’re running, the path would be context.entity.tag — that will obtain and supply the value.

4. If you want to override the options that are available to a user running the Workflow, toggle on Is value override.

   • For example, if you wanted to restrict the project name to some set of values based on a particular HTTP fetch, you would toggle this setting on.

   • When toggled on, the value being grabbed in lieu of project_name is the value of the variable. When toggled off, the value grabbed would be the option provided for that variable, i.e. the project name.

Running a workflow with a Scaffolder step

When you run a workflow with a Scaffolder block, the Scaffolder will prompt you for user input. Some fields, such as Commit message and Pull request title, only appear if your Scaffolder step creates a Pull Request rather than a repository.

After the inputs are provided, the Scaffolder will run. When the run is complete, you will see a link to the newly-created repository and the entity in Cortex.

The User input block pauses the Workflow and prompts the user for specific inputs. Once user inputs are entered, the Workflow will proceed to the next block.

To configure a user input block:

1. Click User input from the list of actions.

2. Enter a name.

   • The slug field will automatically pre-populate based on the name you enter.

3. Click Add user input.

4. Configure the "Create input field" form:

   • Name: Enter a name for the input field.

   • Key: Enter a value to be used when templating. This must be unique across fields in a given user input block.

   • Description: Enter a description of the input field.

     • It is possible to use templating to reference previous block outputs in the description.

       • For example, if a previous step creates a Pull Request and outputs the URL of the PR, you might want to reference it in the description of a subsequent User Input step using a template: Confirm that you have merged the Pull Request created here: {{ actions.<block-slug>.outputs.response.gitURL }}

   • Type: Select from the following:

     • Number: A numerical value.

       • If you select this type, you can then choose Integer or Decimal for the number format, and select a minimum and maximum value.

     • Paragraph: Multi-line, freeform text.

     • Secret: Capture a secret value.

     • Select: Manually configured or predefined data selection.

       • Toggle on Allow multiple to enable multiple selections for a given input field.

     • Text: Short, freeform text.

     • Toggle: Boolean value.

     • Date: Date in YYYY-MM-DD format.

     • Nested form: Users can enter data multiple times for the inputs you configure.

       • Additional configuration is required for this type. See the additional steps for the Nested form type below.

   • Placeholder: Enter text to display when a field is empty.

   • Default value: Enter a value that will automatically populate the field.

   • Validation regex: Set validation options for the input field.

     • If you chose the Secret type, enter the secret value that a user will need to input to run this action.

   • Path to override value: Optionally, enter the previous block output path to override the value of a given input.

     • For example, if the key is name, then entering actions.name-action.outputs.name in the previous block output path field will use the output from a previous step as the name.

     • Is override value editable: Enable this option if you want to allow users to edit the override value before continuing to execute the Workflow.

5. To add validation logic, enable the toggle next to Validation logic.

   • See "Add valiation logic" below for more information.

6. Additional configuration is required for the Select type. See the additional steps for the Select type below.

7. Click Add input at the bottom of the "Edit input field" modal.

8. Click Save.

Additional steps for the Select type

If you chose the type Select while configuring the user input block, additional fields must be configured depending on which Data source you select:

• Manual data source: You can manually define each option for the input. You can select any of these defined options as the default value.

  • When adding options you can define a label for it. If the label is not defined, the value will be used as the label.

• Cortex entity data source: You can filter the entities that will be available for user selection. If you don't set filters, the input will apply to all entities.

  • If you want the user running the Workflow to only see their owned entities as options during this User Input step, enable the toggle next to Limit options to runner user's scope.

    • To only show the user teams they belong to, enable this toggle and select team under the Entity type filtering option.

• Cortex user data source: You can filter by teams and users to determine the options available to users. If you don't set filters, the input will apply to all Cortex users and Teams.

• Slack channels data source: You can choose to include or exclude one or more Slack channels from the available options. The default values will include all Slack channels registered in Cortex.

Additional steps for the Nested form type

A nested form allows users to provide an arbitrary number of responses to a form. For example, you may have a data warehouse form built into your Workflow, requiring users to enter a name and size for their database instance. If they create multiple instances, they can enter multiple responses in the form.

While adding inputs to the User input - Nested form type block, you cannot add another Nested form input within in.

There are additional configuration options while adding a Nested form:

• Element count: You can set a minimum and maximum number of elements that users can enter.

• Path to override value: You can override the input itself with an array of objects. It must meet the allowed element count limits.

Add validation logic

You can define custom JavaScript-based validations on Workflow input fields, ensuring that users are correctly inputting required fields and adhering to standards. For example, you might want to configure validation to ensure users are adhering to predefined naming conventions for new repositories or you may want to validate that the chosen repository name is unique.

To add validation:

1. While configuring the user input block, click the toggle to enable Validation logic.

2. Enter a JavaScript expression.

   • You can call validator.addInputViolation to display an error on a specific input, and validator.addGlobalViolation to display an error at the top of the form.

     • If you call validator.addInputViolation with an invalid input key, the error will display at the top of the form.

   • For example, the following expression adds validation to ensure that a role value has at least three characters and the selected date must be in the future. It is configured to display input-specific errors for the User role and Target date inputs, and a global error if any field is invalid:

let currentOutputs = actions['user-input'].outputs;
let isAnyFieldInvalid = false;

if(currentOutputs['user-role'].length < 3) {
    validator.addInputViolation('user-role', "Role must have at least 3 characters")
    isAnyFieldInvalid = true;
}

let selectedDate = Date.parse(currentOutputs['target-date'])
let currentDate = Date.now()
if(selectedDate < currentDate) {
    validator.addInputViolation('target-date', "Selected date must be in the future")
    isAnyFieldInvalid = true;
}

if(isAnyFieldInvalid) {
    validator.addGlobalViolation("Not all fields are valid, please fix before continuing");
}

When you run the Workflow and enter a response to the user input, the validation logic runs. If there are any issues, they are flagged at that time. Based on the example above, errors will appear if you do not enter at least three characters for the user role field value, and if you do not select a date in the future for the target date field.

This block allows you to set or update specific variables during a Workflow. The variables must be declared in the Workflow's basic settings.

To configure a Set variable(s) block:

1. Click Set variable(s) from the list of blocks.

2. Enter a slug for the block.

   • The slug field will automatically pre-populate based on the name you enter.

3. In the Variable dropdown, select the variable you want to set/update.

4. Define how you want to set the variable's value. You can use a direct reference or use JavaScript.

5. Optionally, set additional variables.

6. Click Save.