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, select Get Started to proceed to 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, you must use the API key associated with that workflow.

You can display the API key using the view option or copy it using the copy option.

The API key must be kept confidential. Do not expose it 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 waits for a server response before it is 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 defines the additional request capacity allowed during short periods of increased request traffic.

These settings help manage API requests to the workflow in a controlled manner.

9.4. Managing the API Key​

The existing API key can be renewed using Regenerate or removed using Delete.

When an 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.

To access the relevant API documentation, select Open Documentation.

When integrating the workflow with an external system, refer to the API documentation for the required endpoint, authentication, and request details.

9.6. Common Errors​

If an API call fails, verify that the API key being used is correct and valid.

If you receive an authorization error, make sure that 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, check the workflow execution duration together with the configured Request Timeout value.