For the complete documentation index, see llms.txt. This page is also available as Markdown.

POST

Send an API POST request with an optional body and store the response.

POST sends data to an HTTP endpoint and stores the response. Use it to create resources, log in through an API, or seed data before UI steps.

POST Test Step

When to use it

  • Create a record the UI will open next.

  • Exchange credentials for a token, then pass that token in Headers on later API steps.

  • Assert the response with Check JSON Value using the same storage name.

See Test APIs in a Flow for a full example.

Configure

Basics

Field
What to set

URL

Fully qualified URL, or a Value that expands to one

Body Content-Type

JSON (default), JSON:API, XML, Plain Text, URL Encoded, Form Data, or No Body

Body

Request body (editor matches Content-Type)

Response Storage Name

Name for the stored response (response by default)

Advanced

Field
What to set

Headers

Request headers as JSON

Expected Response Status Codes

Defaults to 2xx. Choose 201 or other codes when the API requires them

Response Object

Body (default), Headers, or Complete

Status on fail

Pro tip: Keep API hosts and secrets in Assets Values or Recipe overwrites so the same Flow works across environments.

Tags: integration, api, post, rest

Last updated