Map input parameters for your API endpoint. You can provide static values or map
fields from your pipeline data to API parameters.
Limited Availability: ^ This
feature is currently available only in select workspaces and might be subject to
change before general availability.
You must have an API endpoint already configured. See Add an API endpoint for instructions.
Input configuration allows you to specify which data from your pipeline will be sent
to the API. You can provide static values or map fields from your pipeline data to
API parameters. The available input fields depend on which parameters were exposed
when you configured the API endpoint.
-
Navigate to the input configuration section for your API endpoint.
-
Review the list of available input parameters. Each parameter shows:
- Property: The name of the API parameter.
- Type: The data type of the parameter.
- Enter Value or Map Field: Where you provide the
input.
-
For each parameter, choose how to provide the value:
- To enter a static value: Type the value directly
in the input field.
- To map a pipeline field: Click the dropdown and
select a field from your pipeline data. You can also drag and drop
fields from the available fields list.
-
For array parameters, configure multiple rows or row-sets as needed. Array
parameters allow you to pass multiple values or complex objects. For example,
you can configure multiple addresses in a single array parameter.
- Click Add Row to add another entry to the array.
- Configure each row with the appropriate values or field mappings.
-
Review your configuration. Mapped fields are visually distinguished from static
default values.
Note: Mapped fields typically appear in a different
color or with a special indicator to show they are connected to pipeline
data rather than static values.
-
Click Save to save your input configuration.
Your input parameters are now configured. The API will
receive the values or mapped fields you specified when the endpoint is called. After
configuring input parameters, proceed to configure output parameters to specify which
response data you want to use in your pipeline.