Core Nodes
API / HTTP Call

API/HTTP Call Node

The API Call is a powerful utility node to HTTP requests to external APIs for data retrieval, submission, or triggering actions.

API Call Node

Steps to use API Call Node

Accessing the Node Editor

  • Navigate to the Node Editor where you are building your workflow.
  • Locate the 'API Call' node that you want to configure.

Testing the 'API Call' Node

  • HTTP Method: Set the HTTP method for the request. In most cases, you'll choose 'GET' for retrieving data from an API.
  • Content Type: Specify the content type for the request. For JSON data, set it to 'application/json'.
  • URL: Enter the URL of the API you want to call.

Returning the API Call Output

Once you've configured the 'API Call' node, you can proceed to test it. To do so, follow these steps:

  • Click on the 'Test Node' button located in the top-right corner of the Node Editor.
  • The platform will execute the 'API Call' node's logic using the parameters you entered.
API Call Node Testing
  • If the execution is successful, a green check-mark will appear on the node.
💡

In case of an unsuccessful execution, an error message will be displayed. For example, an incorrect URL can lead to an error.

  • To view the output of the test run, click on the check-mark. You can copy the output by scrolling to the bottom and clicking 'Copy Value'.

Logging During Node Execution

If you need to log specific information during the execution of the 'API Call' node, you can include a logging statement in the code. This can be helpful for debugging and monitoring the behavior of your workflow.

Logging

Video

That's it! You've successfully configured and tested an API call using the 'API Call' node in our platform. If you encounter any issues or have questions, feel free to reach out to our support team for assistance.

Need Help?

  • 💬
    Join BuildShip Community

    An active and large community of no-code / low-code builders. Ask questions, share feedback, showcase your project and connect with other BuildShip enthusiasts.

  • 🙋
    Hire a BuildShip Expert

    Need personalized help to build your product fast? Browse and hire from a range of independent freelancers, agencies and builders - all well versed with BuildShip.

  • 🛟
    Send a Support Request

    Got a specific question on your workflows / project or want to report a bug? Send a us a request using the "Support" button directly from your BuildShip Dashboard.

  • ⭐️
    Feature Request

    Something missing in BuildShip for you? Share on the #FeatureRequest channel on Discord. Also browse and cast your votes on other feature requests.