Breadcrumbs

Call API

Call API connects your tool to an external system over HTTP: fetch data, create or update records, trigger actions.

Request

  • Method: GET fetches data, POST creates, PUT and PATCH update, DELETE removes. Which one to use is defined by the API you are calling.

  • URL: the full address of the API, including https://.

  • Headers: extra information sent with the request, such as an Authorization token or Content-Type.

  • Query: values appended to the URL, such as an ID or a filter.

  • Body: the data sent along with POST, PUT, PATCH, or DELETE requests (a GET request has no body). Choose the Body type (JSON, Text, HTML, or XML) and enter the content. Insert flow values as {{variable}}; they are filled in when the step runs.

Settings

  • Follow redirects: when on, the request follows the API's redirect responses automatically.

  • Timeout (s): how many seconds to wait for a response. The step fails if the API takes longer.

  • Apply JMESPath expression: keep only one value from the response instead of the whole thing. The expression runs against the full response, so body.data.email picks a value from the body, status picks the status code. No match gives an empty result; an invalid expression fails the step. JMESPath is a standard query language for JSON, see jmespath.org.

Response

The response is stored in the variable you pick under Select output variable. It contains the status code, the headers, and the body, so a later step can read body for the data or check status for success.

Supported response formats are JSON, XML, and plain text. If the API responds with something else, add an Accept header to the request, for example Accept: application/json.