Skip to navigation

Call an API

View as Markdown

When you need to talk to a service that a workflow does not have a built-in step for, you send it an HTTP request directly. You set the method and URL, add any headers the service needs, and then read the response in later steps.

Nodes involved

How to build it

1

Set the method and URL

Add an HTTP Request step. Choose the method (such as GET or POST) and enter the URL of the service you are calling.

2

Authenticate with a secret

Open Workflows > Variables & secrets > Secret Variables, click Create Secret, and save the credential with the name api_key. See Save a secret for the full steps. If the builder was already open, let its changes save and reload it to refresh the secret picker.

In the HTTP Request node’s Headers section, click Add and enter Authorization as the header name. For a service that uses bearer tokens, switch the value’s mode to CEL only, click Edit expression, and enter:

"Bearer " + secret.api_key

Apply the expression to the field. The workflow stores the secret reference. If the service expects a key without a prefix, use secret.api_key in the header the service requires instead.

3

Use the response

Connect the HTTP Request node to the next step. In that step’s variable picker, select the HTTP Request node’s response_body, status_code, or response_headers output. Use the picker to insert the reference with the correct node ID, then select the response field you need. For example, a node with the ID lookup_account exposes its body as node.lookup_account.response_body.

If the service can be slow or flaky, review the step’s time limit and retry behavior. See Timeouts & Retries.