API Trigger
Learn more about the API Trigger and how to use it on the Digibee Integration Platform.
The API Trigger exposes an integration through a REST endpoint. When a pipeline is configured and deployed with this trigger, a REST endpoint is automatically generated. You can view this endpoint on the pipeline card in the Run page after deployment.
Routes List configuration
To start configuring the trigger, follow these steps to set up the Routes List:
In the Routes List section, click Add.
Enter the Path (for example, "/users").
Select the appropriate Method.
Add a description in the Summary (such as "Retrieves all users").
After creating the route, it will appear in the Routes List. You can add new routes, edit existing routes, or delete them.
Alternatively, you can create a pipeline with an OpenAPI specification file. Learn more about how to scaffold a pipeline using an OpenAPI specification.
Visual representation of the routes
Once you save the configuration of the trigger, a visual representation of the routes is displayed in the pipeline.
The routes can only be edited through the trigger's configuration form. After saving, any changes will be immediately reflected in the pipeline.
Each route is connected to a Block Execution connector, which is designed to logically separate the integration into different subflows for easier pipeline management. To complete the configuration, you will need to create the flows for each route within the OnProcess and OnException subflows.
Important information:
If you create the flow before configuring the trigger, the existing connectors will be disconnected once the trigger is configured.
Deleting a route from the Routes List will disconnect the Block Execution connector for that route from the main flow.
Changing the API Trigger to another type of trigger will convert the Router into a Choice connector, and the previously configured routes will automatically be connected to the Choice.
In each of these cases, you can copy the connectors within each Block Execution and paste them elsewhere in the pipeline.
Parameters
Take a look at the configuration parameters for the trigger. Parameters supported by Double Braces expressions are marked with (DB)
.
There is a global configuration parameter that specifies that all pipelines must be published with at least the API Key or Basic Auth options enabled.
Parameters additional information
Further details on the parameters can be found below:
Last updated