Custom API Calls
Overview
Alloy Flow supports hundreds of apps. When situations arise that may require you to make API calls beyond the connectors we support natively, you may use the Custom API connector.
How it Works
To get started with the Custom API connector, add it to your workflow as seen below. The Custom API connector requires you configure the following:
- URL: The place to send the HTTP request
- Request Method: The type of method you are making (i.e. GET, POST, etc)
- Headers: Any request headers you'd like to provide
- Body: Any body data to send along
You can easily configure the Custom API block authentication (we support basic auth, header auth, and no auth).
Alloy X-Headers
Whenever you make a request using the Custom API block, Alloy Flow attaches the following headers:
| Parameter | Description |
|---|---|
X-Alloy-WorkflowId | The workflowId of the workflow where this request originated from |
X-Alloy-UserId | The current userId the workflow is being invoked for |
X-Alloy-BlockName | The starting event block that triggered the workflow |
X-Alloy-BlockType | The starting event block type (i.e. Shopify) that triggered the workflow |
X-Alloy-ExecutionUuid | The unique identifier for the current execution. Useful if you want to rerun an execution after the fact |
Wrapping Up
In this article, we took a look at how to use the Custom API connector to make HTTP requests.