Making API Requests

Easily query any API directly with Paragon's request step.

Overview

You can make requests to any HTTP API using Paragon's Request step. This is useful building workflows that interface with your own internal APIs, or with services that Paragon might not support integration with yet.

Making a Request

To add a request to your workflow, click the "+" button in the workflow canvas and choose the Request step from the sidebar. You can follow familiar specifications to setup requests in Paragon:

  • URL

  • Request type

    • POST

    • GET

    • PATCH

    • PUT

    • DELETE

  • Request data

    • Query parameters

    • Headers

    • Body parameters

Configuring your Request URL

You can enter the request URL in the input under "Make an HTTP request to". You can also include parameters as part of the URL by typing {{ to invoke the variable menu.

The variable menu allows you to reference data from upstream steps in your request URL. For example, we can pass a userId from the Trigger into the request URL, which is represented as: /users/{{1.request.body.userId}}

Sending data in the request

Query parameters, headers, and body parameters can be included in the request by adding them in the key-value table under "What data should be included in the request?".

When using the key-value table, you can type in static values or reference variables from upstream steps by invoking the variable menu using the dropdown button.

Sending JSON in a request

The easiest way to send JSON in a request is by first defining the JSON object in a Function step, then reference it in the Request step's body parameters. You can reference our docs on how to use Functions here.

Handling request failures

You can choose whether or not the workflow should continue to the next step if the request fails under "Continue workflow if request fails". This option is useful if you want to conditionally handle request failures. You can do this by adding a Conditional step after the Request step, then referencing the request's response status code in the Conditional.