API Function
Overview
A function with pre-defined inputs and outputs that can be used as an API endpoint. You could describe functions as Formulas, Workflows, Flows or Automations.
If you want to provide response headers, you need to place an
object(not array) containing key/value pairs of headers into theResponse Headersoutput data structure.
Parameters
| Parameter | Parameter | Valid Blocks | Required |
|---|---|---|---|
Request Details | These parameters are set by the incoming request when an API call is received. These are read-only. | Basic Type Block Group | No |
Inputs | Set values (that you choose) as inputs to the API request. These are read-only. 💡 If you're building a webapp and don't want to define rigid inputs, add a single data structure called `C-All` to capture all inputs. | Basic Type Block Group | No |
Variables | For variables and constants that you need in this function (these are not asked for or returned from this function). These are read/write. | Basic Type Block Group | No |
Logic Flow | This is where you build logic and call other functions. Blocks will be executed as a sequence of instructions in order (top to bottom, following tree branches on the way down). | Process Block Group | No |
If a single Data Structure output, set as root Response Body | If there is only one output parameter and it's a Data Structure, make it the entire (root) Response Body. 💡 If you're looking to do similar for input parameters (eg. if you're building a webapp and don't want to define rigid inputs), add a single input data structure called `C-All` to capture all inputs. | Boolean Block Group | No |
Outputs | Set values (that you choose) as outputs from the API request. These parameters are used to populate the body of the API response. These are write-only. | Basic Type Block Group | No |
Response Details | These parameters are always returned with your API response. These are write-only. | Basic Type Block Group | No |