An API call is an external request you register once and reuse from any function: sending a message, creating a record in another service, or fetching data.
1
Open API Calls
In the admin panel, go to Forms, then API Calls, and click Add API Call.
2
Name it
Enter a Unique name and create it.
3
Configure the request
Click Edit. On General configuration, choose the Type (POST, GET, PUT, PATCH or DELETE), enter the URL and a Description, then click Save configuration.
4
Chain it if needed
Under Chaining, pick a Previous API call whose response this call needs.
The tabs of an API call are General configuration, Headers, Inputs, Outputs and Test.
Inputs
Values the call accepts: a Unique name, a Default value, a Variable type (string, number, array or object), Required, and Inject in body.
Inject in body
When on, the input is sent in the request body. Turn it off for a value that only goes in the URL.
Headers
Sent with every request, such as an authorization header. Each has a name and a default value.
To place an input in the URL, write the input's name between double curly braces in the URL.
Keep keys out of your settings. In a header value or an input's default value, write process.env. followed by the variable name, between double curly braces, to read one of your project's environment variables. Values supplied when the call runs never read environment variables.
Every value placed in the URL is percent-encoded, so it stays inside its own path segment or query value. A slash becomes %2F, which stops a value typed by a visitor from reaching a different address.
A placeholder at the very start of the URL is used as written. It is the base address.
An input's default value is also used as written.
Do not rely on an input to carry a slash into the middle of a URL. Register a separate API call for each path instead.
1
Open the Test tab
Fill in the inputs and headers for this test.
2
Choose Full response
Click Send Request to see the raw response.
3
Register outputs
Click the + next to any value in the response body to register it as an output. Output names are paths starting with data. or headers.
4
Validate
Switch to Filtered response and send again. Only the registered outputs are extracted, their types are checked, and they show as validated.
A test sends a real request. If the API creates, charges or sends something, that happens.
In the Node Editor, add an Execute API node and choose the call in Configure External API. The node gets an input port for each input and header, and an output port for each validated output.
An HTTP error does not stop the function. Check the response in your own nodes, for example with an If node. A dry run on the Test tab does not undo API calls.
