API

Understand what an API pipeline is on the Digibee Integration Platform and how it simplifies the creation and configuration of HTTP-based integrations.

What is an API pipeline

An API pipeline lets you set up a pipeline with the API Trigger without opening the Canvas from the start. You configure endpoints, authentication, rate limiting, and CORS through a dedicated interface on the Pipelines page, and the platform generates the Canvas structure automatically.

The result is a pipeline with all routes already configured and structured following best practices. To open the Canvas at any point, click the three-dots button on the pipeline card and select Open Canvas. You can also configure the API Trigger there.

How it works

When you create an API pipeline, the platform automatically builds the following structure in the Canvas:

• An API Trigger as the pipeline entry point.

• A Router connected to the trigger, responsible for directing requests to the correct route.

• A Block Execution connector at the end of each route, organizing the pipeline into subflows.

• OnProcess and OnException subflows inside each Block Execution, for handling success and error responses.

• An Endpoints menu in the left sidebar, with quick access to all configured routes.

Each endpoint added through the interface automatically generates this structure in the Canvas. You can configure the logic for each route by opening the OnProcess and OnException subflows directly from the Actions column in the configuration interface.

API pipeline and REST pipeline

Both use HTTP triggers and share the same icon in the pipeline listing. The difference lies in how they are created and configured:

	API pipeline	REST pipeline
Creation	Dedicated interface on the Pipelines page or Canvas	Canvas
Route configuration	Dedicated interface or Canvas	Canvas
Automatically generated structure	Yes	No
Canvas access	Available at any point	Opens by default

To identify the trigger type of a pipeline in the listing, hover over the card. A tooltip displays whether the trigger is API or REST.

Pipelines created with the API Trigger before this feature are also updated to this model and can be configured either through the dedicated interface or directly inside the Canvas.

Summary

• An API pipeline is created and configured through a dedicated interface on the Pipelines page, without needing to open the Canvas from the start.

• The Canvas structure (trigger, router, Block Execution, and subflows) is generated automatically from the configured endpoints.

• The Canvas remains accessible at any point for adjustments and advanced configurations.

• REST pipelines are not affected by this feature.

Next steps

Now that you understand the concept, read How to create an API pipeline to configure your first pipeline step by step.