Skip to main content
GuidesAPI Reference
Version: 5.0.0

Custom API Calls

Overview​

Alloy Embedded supports over 270 (and counting) apps. Unfortunately, we don't have everything. As such, situations arise that may require you to API calls beyond the blocks we support natively.

How it Works​

To get started with the Custom API block, add it to your workflow as seen below. The Custom API bock 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). Use the Variable Selector to map fields accordingly.

Alloy X-Headers​

Whenever you make a request using the Custom API block, Alloy Embedded attachs the following headers:

ParameterDescription
X-Alloy-WorkflowIdThe workflowId of the workflow where this request originated from
X-Alloy-UserIdThe current userId the workflow is being invoked for
X-Alloy-BlockNameThe starting event block that triggered the workflow
X-Alloy-BlockTypeThe starting event block type (i.e. Shopify) that triggered the workflow
X-Alloy-ExecutionUuidThe 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 block to make HTTP requests.