Call an API | Gail Documentation

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

HTTP Request sends the request and returns the response.

How to build it

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.

Authenticate with a secret

Most services need a credential. Store it as a secret and build the Authorization header from it rather than typing the key in:

"Bearer " + secret.api_key

The real key never appears in the workflow.

Use the response

Later steps can read the response by referencing the step, for example:

http-request.data.body

Point a downstream field at the part of the response you need.

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

HTTP Request

Every option for sending a request.

Secrets

Store the credential the request needs.