Postman Flows blocks

The blocks available in Postman Flows are described below.

Information blocks

Template

Template block

Enables large amounts of formatted text to be entered. The values in the variables section can be included in the text using {{key}} where key is the name of your variable.

Variables - Named information or assigned values that can be included in the text using the {{key}} format. Variables created in Flows aren't available to post-response scripts or other features outside Postman Flows.

Out - Sends the information entered in the text box to the next block.

Example

Get Variable

Get Variable block

Gets the specified variable's value from anywhere in the Flow.

Example

Create Variable

Create Variable block

Assigns a value to a variable that can then be accessed with the Get Variable block anywhere in the Flow. The input is any value (such as text, a number, or information from another block).

Example

Record

Record block

Structured information that can hold any of the other value block types or another record. Information is organized by having a key (the name assigned to the information) and a value.

Example

List

List block

Outputs the specified list of values. Each item can be any type of block, for example, a date block, a string, or a record. Using a Select block in a row of the list enables information from another block to be passed into the list.

Example

Date & Time

Date & Time block

Outputs the specified date and time.

Example

Date

Date block

Outputs the specified date.

Example

Now

Now block

Outputs the current date and time.

Example

Select

Select block

Selects a specific part of the information output from another block. If the input information is from a Send Request block with a saved example, a drop-down will pop up that has all the information available to choose from and selecting that information will auto-fill the select block.

You can also create a Select block by dragging and dropping output data from a Send Request or Output block. The new Select block automatically selects the data you dragged and dropped.

Select block

Example

Regex

Regex block

Outputs a regular expression.

Example

Null

Null block

Outputs a null value.

Example

Number

Number block

A whole or decimal number that can be positive or negative.

Example

Bool

Bool block

True or false.

Example

String

String block

Outputs the text that you enter.

Example

Start

Start block

The first block that runs when a Flow is run. When deploying to the cloud, running Flows on the cloud can be configured to hold information (either as text or in JSON format) for testing locally.

Example

Decision blocks

If

If block

Takes any number of variables and information, and takes a different branch depending on the result of the FQL condition.

Variables - Named information or assigned values.

Text entry block - Freeform query using FQL that evaluates to true or false.

Data - Receives information or an event from another block.

Outputs - Sends the information to either the True or False pathway depending on the value of the FQL condition.

Example

Evaluate

Evaluate block

Executes FQL to change information and work with variables.

Variables - Named information or assigned values that can be accessed using FQL.

Text entry block - Freeform query using FQL.

Out - Outputs the result of the query.

Example

Repeating blocks

Repeat

Repeat block

Runs all of the blocks that come after it the specified number of times until a Collect block is encountered in which case it will stop repeating all blocks that come after the Collect block.

Count - The number of times to run the block.

Start - Runs the block when it receives input from another block.

Index - The number of the current run starting at 0 for the first run.

Example

For

For block

Runs all of the blocks that come after it once for each item in the input list until a Collect block is encountered in which case it will stop repeating all blocks that come after the Collect block.

List - A list of values like [1,2,3] or ["one","two","three"].

Start - Receives an input to run the block.

Item - Outputs a single item in the list.

Example

Collect

Collect block

For and Repeat blocks will stop repeating once this block is reached. Every item will be put into a new list and then output.

Item - Takes in a single item from a for or repeat sequence.

List - Creates a list of all items sent to this block in the for or repeat sequence.

Finish - Sends an event when the block is complete (when the for or repeat sequence has been run for every item and they're all in a new list).

Example

Action blocks

Send Request

Send Request block

Runs a request in a collection and outputs the result. If a request that has a saved example was used, the result can be used as test data to run the Flow and autofill Select blocks.

Select a Request - Select a collection and a request here.

Send - When this receives any input from another block, the selected request is run.

Create with AI

Create AI block

The Create with AI block is a beta feature available to users with the Postman Free, Basic, or Professional plan.

The Create with AI block generates and outputs text, images, and JSON data in your Flows using the GPT-3.5, GPT-4, and DALL-E 3 artificial intelligence (AI) models. You can enter and test prompts that describe what you want the Create with AI block to generate.

To reference variables in your prompts, use curly braces. For example, these prompts include variables:

  • Summarize the response in {{value1}}.
  • List all the new customers in {{body}}.
  • Visualize the data in {{expenses}} as a pie chart.

variable - Assign incoming data to a variable. Select the Add data blocks icon Add data blocks icon to add more variables as data blocks. Use curly braces to reference variables in your prompts like this: {{value1}}.

Mode selection dropdown list - Select Text, Image, or JSON to specify the type of data you want to create. Select Smart to let the Create with AI block automatically recognize the type of data based on your prompt.

Text entry block - Enter AI prompts here.

Test your prompt - Select to get results or feedback from the AI in the Create with AI block.

Output - Send data from the Create with AI block. The icon next to this port changes depending on which mode is selected. It shows Aa for Text, ? for Image, and () for JSON.

The Create with AI block consumes more credits than other Postman Flows blocks. Learn more at Manage your team's usage of Postman Flows.

Delay

Delay block

Waits the specified amount of time before allowing information through.

Data (input) - Starts the delay when it receives input from another block.

Data (output) - Once the delay is complete, passes through whatever information was input.

Delay (in ms) - The amount of time in milliseconds to wait.

Example

Success - Has the response of a successful API request. If Postman tests are assigned to the request and all pass or, if there are no tests, a 2xx (successful) HTTP status code is received. The information returned by the request is then output to the next block.

Failure - Has the response of an unsuccessful API request. If Postman tests are assigned to the request and all fail or, if there are no tests, a non 2xx (unsuccessful) HTTP status code is received. The information returned by the request is then output to the next block.

Example

Output blocks

Log (Console)

Log block

Sends the information input to the block to the Postman Console.

Example

Output

Output block

Displays the information input. The dropdown menu enables you to select from JSON, charts, tables, videos, images, and more. For more information and examples on the output block, see Visualizing data.

Last modified: 2023/11/22