Workflow API Integration
9. Workflow API Integration
API integration allows a workflow to be executed programmatically through custom applications, backend services, webhook systems, or automation tools.
After selecting the integration method, use Get Started to proceed with the API configuration.
This opens the API Keys screen for the selected workflow.
From this screen, you can view and copy the API key, configure request timeout and rate limit settings, and access the relevant API documentation.
9.1. Workflow API Key
The API Key is the authentication credential used to call the selected workflow from external systems.
The generated API key is valid only for the selected workflow. To call a different workflow, the API key associated with that workflow must be used.
The API key can be displayed using the view option or copied using the copy option.
The API key must be kept confidential. It should not be included in public source code repositories or environments accessible to unauthorized users.
9.2. Request Timeout
Request Timeout determines the maximum amount of time a request will wait for a server response before being canceled.
This value can be configured according to the duration of the operations performed by the workflow.
9.3. Rate Limit and Burst Tolerance
Rate Limit determines the number of requests that can be made per second through the API.
Burst Tolerance specifies the additional request capacity allowed during short periods of increased request volume.
These settings help ensure that API requests made to the workflow are managed in a controlled manner.
9.4. Managing the API Key
The existing API key can be renewed using Regenerate or removed using Delete.
When the API key is regenerated, the previous key used by existing integrations may become invalid. In this case, the API key used by external systems must also be updated.
9.5. API Documentation
API Documentation provides access to endpoint references, authentication information, and request examples for the selected workflow.
Use Open Documentation to access the relevant API documentation.
When integrating with external systems, refer to the API documentation for the relevant endpoint, authentication, and request information.
9.6. Common Errors
If an API call fails, verify that the API key being used is correct and valid.
If an authorization error occurs, make sure the API key belongs to the relevant workflow.
If the workflow cannot be executed, verify that the workflow has been published.
If a timeout error occurs, review both the workflow execution time and the configured Request Timeout value.