REST Client

A collection of components that enable your flows to make HTTP Requests. Using flows, scalable REST API integrations with your data have never been simpler or faster.

There are two categories of components:

Authenticators - Authenticates requests for a specific service.
Operations - HTTP requests type/method.

Authenticators

Used to authenticate each HTTP request. We've included several authenticators for common APIs out the box that will save you some time. If you don't see an authenticator for the service you're interested in, use one of the manual authenticators: Basic, Bearer, or Public.

To authenticate a request:

Add Authenticator Component
Enter required component properties
Connect the Authenticator's reference (side) output to the Operation Component. Each authenticator can be connected to multiple Operation Components, avoiding component duplication.

Basic Authenticator (Manual)

For APIs that use Basic Access Authentication, enter your Username and Password.

Bearer Authenticator (Manual)

For APIs that follow the Bearer scheme, provide your auth token here. Currently, Flow Director cannot obtain tokens dynamically through the OAuth2 framework. In other words, the API must allow the use of pre-generated tokens.

Public Authenticator (Manual)

When an API does not require authentication, connect the required connector to this component.

Flow Director Authenticator

Used to make requests to any Flow Director App that has API routes defined.

Mailchimp Authenticator

Provide your Mailchimp Account's API Key. You can find your API Key from Account / Extras / Your API keys.

PayPal Authenticator

Provide your PayPal App's Client ID and Secret. Find them in My Apps & Credentials / SomeApp.

Slack Authenticator

Provide your Slack App's OAuth Token. Find it Apps / Some App / OAuth & Permissions.

Operations

Operation Components make the actual HTTP request. You'll find a component for each HTTP Request Method:

GET
POST
PUT
PATCH
DELETE

URL

The request endpoint. Be sure to include the scheme, too, https:// or http://.

Headers

You can specify key/value pairs for custom request headers.

POST / PUT Data

Provide the request body. Checking Send JSON will set the header's content type to application/json. Some APIs require this.

Dynamic URLs, Headers, or Data

You can include values from an incoming Message or a statically set Flow Parameter within a URL, header, or request data to build dynamic requests.

Referencing a Dynamic Value

{someproperty} - The value of a property with the name someproperty from the incoming message.
{{flowparam}} - A statically set flow parameter named flowparam.

Using dynamic values, your data trigger compound actions like sending an email to a customer based on the Order Message's customer email property value or post a notification to Slack whenever a critical event