Configure a new API endpoint by selecting an API source and defining which request
and response parameters to expose in your pipeline.
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 source already created. See Add an API source for instructions. When
you add an API endpoint, you select which parameters from the API will be exposed
for configuration in your pipeline. You can also provide friendly names for
parameters and set default values.
-
Navigate to the API Call section in your pipeline or workflow.
-
Click Add new Endpoint.
-
Configure the connection details:
- Select the API Source from the dropdown
list.
- Select the API Endpoint from the available
endpoints in the selected API source.
-
Enter the API Name. This is the name that will appear in
your pipeline.
-
Enter the API Description. Provide a clear description
of what this endpoint does.
-
Configure the request parameters:
The request configuration section displays all available parameters from the
selected endpoint. The content is automatically populated based on your
endpoint selection.
- Review the list of available parameters.
- For each parameter you want to use, select which parameters will be
exposed for user entry in the pipeline.
- Optionally, provide a default value for any parameter.
- Optionally, rename a parameter to a friendlier name that will
display in the pipeline or workflow.
- Click View sample payload to see an example
of the request data structure.
-
Configure the response parameters:
The response configuration section allows you to select which response
parameters from the API will be available in your pipeline.
- Review the list of available response parameters.
- Select which response parameters you want to expose for use in your
pipeline.
- For each selected parameter, provide a friendly name if you want to
change the default name.
-
Click Save to create the API endpoint.
The API endpoint is now configured and ready to use. You can
now configure the input and output parameters for this endpoint in your pipeline. After
creating an API endpoint, proceed to configure input parameters and configure output
parameters.