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)
.
Parameter | Description | Default value | Data type |
---|---|---|---|
Maximum Timeout | Maximum time (in milliseconds) for the pipeline to process information before returning a response. Limit: 900000 ms. | 30000 | Integer |
The Maximum Allowed Request Size In Mb | Maximum size of the payload (in MB). The maximum configurable size is 5 MB. | 5 | Integer |
Response Headers | Headers returned by the endpoint when the pipeline processing is complete. This parameter is mandatory. | N/A | String |
Add Cross-Origin Resource Sharing (CORS) | Enables the addition of CORS headers. | False | Boolean |
CORS Headers | CORS headers returned by the endpoint when the pipeline processing is complete. Available only if the Add Cross-Origin Resource Sharing (CORS) parameter is active. | N/A | Key-value pair |
External API | If active, publishes the API in an external gateway. | True | Boolean |
Internal API | If active, publishes the API in an internal gateway. Both the External API and Internal API options can be active simultaneously. | False | Boolean |
mTLS Enabled API | If active, publishes the API to a dedicated gateway with mTLS enabled by default. | False | Boolean |
API Key | If active, the endpoint can only be consumed if an API key is configured on the Digibee Integration Platform. | False | Boolean |
Token JWT | If active, the endpoint can only be consumed if a JWT token generated by another endpoint is sent. Read more in the article about JWT implementation. | False | Boolean |
Basic Auth | If active, the endpoint can only be consumed if Basic Auth is present in the request. This setting can be registered beforehand through the Consumers page in the Digibee Integration Platform. | False | Boolean |
Rate Limit | If active, applies rate limiting on the API gateway. Available only if the API Key or Basic Auth parameters are active. | False | Boolean |
Limit by | Defines the entity to which the limits will be applied. Available only if the Rate Limit parameter is active. | API | String |
Aggregate by | Defines the entity for aggregating the limits. Options: Consumer and Credential (API Key, Basic Auth). Available only if the Rate Limit parameter is active. | Consumer | String |
Options | Defines the limit of requests that can be made within a time interval. Available only if the Rate Limit parameter is active. | n/a | Options of Rate Limit |
Interval | Defines the time interval for the limit of requests. Options: second, minute, hour, day, and month. Available only if you add a new Option. | second | String |
Limit | Defines the maximum number of requests that users can make in the specified time interval. Available only if you add a new Option. | n/a | Integer |
Allow Redelivery Of Messages | If active, allows the message to be resent if the Pipeline Engine fails. Read more in the article about the Pipeline Engine. | False | Boolean |
Documentation | Section for documenting any necessary information about the trigger configuration and business rules. | N/A | String |
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