REST API Node

  • Input Params Tab:

    • Integration Dropdown: Allows you to choose from a pre-configured list of services for which the REST API will be called. In the screenshot, 'Airtable' is selected, indicating that this REST API node is configured to interact with the Airtable service.

    • Select Method Dropdown: Here you specify the HTTP method to be used for the API call. The options usually include GET, POST, PUT, DELETE, etc. The method you select will determine the nature of the interaction with the API (e.g., GET for retrieving data, POST for creating data).

    • Base URL Input Field: This is where you enter the root URL for the API service. It acts as the starting point for the API request. The provided example is https://api.airtable.com/v0/, which indicates that the API calls are directed to Airtable's base endpoint.

    • Authentication Dropdown: Determines the type of authentication required for the API call. Options could include 'None', 'Bearer Token', 'Basic Auth', 'OAuth2', etc. 'Private' likely refers to a predefined, secure method of authentication configured within Nected for Airtable.

    • URL Path Input Field: Appends the specific path to the Base URL to target a particular resource or data set within the API. For instance, if you were targeting a specific table within Airtable, the URL path might include the table's name or identifier.

    • Headers Section: Sometimes optional, headers can be used to provide additional information to the API call, such as content types, API keys, or other metadata. You can add headers by clicking on 'Add Headers', and you'll likely need to enter both the header name and its value.

    • Query Parameters Section: Also often optional, this is where you can specify query parameters that modify the request or filter the data being requested. Adding query parameters will typically involve specifying both the parameter name and the value you wish to set.

    • Expand to see the IP addresses to add to your allow-list Section: Some APIs have IP allow-listing as a security measure. If you need to ensure that your workflow's server IPs are allowed to make requests to the API, you can add them here.

Note: Always ensure that you have the correct permissions and have followed the API provider’s data protection guidelines when configuring API nodes, particularly when dealing with authentication and header information.

  • Test Results Tab:

    • Execute the API request to test the connection and response handling. The response (or any errors) will be displayed here.

  • Settings Tab:

    • In the settings tab, you can adjust the timeout time for the Rest API.

The 'Test' and 'Save' buttons at the bottom of the tab are used to test the API call with the configured parameters and to save the node configuration if the tests are successful.

Last updated