Actions8
- Execution Orchestrator Actions
- Datapool Actions
Overview
This node integrates with the BotCity orchestrator API, allowing users to manage execution workflows. Specifically, the "Stop Queue Execution" operation under the "Execution Orchestrator" resource enables users to stop a running or queued execution by specifying its unique execution ID. This is useful in scenarios where an automation process needs to be halted due to errors, changes in requirements, or manual intervention.
Practical examples include:
- Stopping a bot execution that is stuck or behaving unexpectedly.
- Canceling queued executions before they start to free up resources.
- Managing execution flows dynamically based on external triggers or conditions.
Properties
| Name | Meaning |
|---|---|
| Execution ID | ID of the execution to stop |
The "Execution ID" property is a required string input that uniquely identifies the execution instance you want to stop.
Output
The node outputs JSON data representing the response from the BotCity orchestrator API after attempting to stop the specified execution. The structure typically includes status information about the cancellation request, such as success confirmation or error details.
If the node supports binary data output (not evident from the provided code), it would relate to any files or logs returned by the orchestrator, but this is not indicated here.
Dependencies
- Requires an API key credential for authenticating with the BotCity orchestrator API.
- The base URL for the API is configured via credentials and sanitized to remove trailing slashes.
- The node depends on the BotCity orchestrator service being accessible and properly configured.
Troubleshooting
Common issues:
- Invalid or missing Execution ID will cause the operation to fail.
- Network connectivity problems can prevent communication with the BotCity API.
- Insufficient permissions or invalid API credentials will result in authentication errors.
Error messages:
- Errors related to "execution not found" indicate the provided Execution ID does not exist or is already completed.
- Authentication errors suggest checking the API key credential configuration.
- Timeout or connection errors require verifying network access and API endpoint availability.
Resolving these usually involves verifying the Execution ID, ensuring valid credentials, and confirming network connectivity.
Links and References
- BotCity Orchestrator API Documentation (example link; replace with actual if available)
- n8n documentation on creating custom nodes