Title: [DX] GAP-06: app_key vs app_name have divergent behaviour with no documentation · Issue #1498 · UiPath/uipath-python · GitHub
Open Graph Title: [DX] GAP-06: app_key vs app_name have divergent behaviour with no documentation · Issue #1498 · UiPath/uipath-python
X Title: [DX] GAP-06: app_key vs app_name have divergent behaviour with no documentation · Issue #1498 · UiPath/uipath-python
Description: Summary sdk.tasks.create() accepts both app_key and app_name + app_folder_path, but their behaviors diverge in a way that is not documented. Using app_key creates the task but makes it unopenable in Action Center. Root Cause app_name + a...
Open Graph Description: Summary sdk.tasks.create() accepts both app_key and app_name + app_folder_path, but their behaviors diverge in a way that is not documented. Using app_key creates the task but makes it unopenable i...
X Description: Summary sdk.tasks.create() accepts both app_key and app_name + app_folder_path, but their behaviors diverge in a way that is not documented. Using app_key creates the task but makes it unopenable i...
Opengraph URL: https://github.com/UiPath/uipath-python/issues/1498
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[DX] GAP-06: app_key vs app_name have divergent behaviour with no documentation","articleBody":"## Summary\n\n`sdk.tasks.create()` accepts both `app_key` and `app_name` + `app_folder_path`, but their behaviors diverge in a way that is not documented. Using `app_key` creates the task but makes it unopenable in Action Center.\n\n## Root Cause\n\n- `app_name` + `app_folder_path`: performs a full schema lookup, correctly links the task to the deployment, and the task opens normally in Action Center.\n- `app_key` (the deployment's `systemName`): bypasses the schema lookup and directly creates the task. The task is created (HTTP 201) but the runtime cannot resolve the app for rendering. When the reviewer tries to open the task, the form shows `{\"errorMessageV2\": \"app not deployed\"}`.\n\nThere is no documentation distinguishing these two parameters or explaining when each is appropriate.\n\n## Observed Behaviour\n\n```python\n# This works\ntask = uipath.tasks.create(\n title=\"Review Invoice\",\n app_name=\"InvoiceReviewForm\",\n app_folder_path=\"Shared/Solution Invoice App\",\n data={...}\n)\n\n# This creates the task but shows \"app not deployed\" when opened\ntask = uipath.tasks.create(\n title=\"Review Invoice\",\n app_key=\"invoice-review-form\", # systemName\n data={...}\n)\n```\n\n## Workaround\n\nAlways use `app_name` + `app_folder_path`. Leave `app_key` empty.\n\n## Suggested Fix\n\n1. Document what `app_key` is (the deployment's `systemName`) and when it's valid to use it vs `app_name` + `app_folder_path`.\n2. Ideally, validate at task creation time that the app is reachable and renderable with the given parameters — similar to how `app_name` does a schema lookup. Fail fast rather than creating an unopenable task.\n3. Add a note in the docstring for `app_key` that it may cause rendering failures if the deployment is not resolvable by that key alone.\n\n## Impact\n\n- Severity: **Medium**\n- Tasks are silently created in an unopenable state; the only indication is the `\"app not deployed\"` error shown to the reviewer trying to open the form","author":{"url":"https://github.com/AlexBizon","@type":"Person","name":"AlexBizon"},"datePublished":"2026-03-26T15:22:57Z","url":"https://github.com/UiPath/uipath-python/issues/1498"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:4ce8de7a-3841-2403-3218-c021860d7e2e |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8E96:2E6021:9189D5:AD78E9:6AFF6A43 |
| html-safe-nonce | 576577a903c363f71a5d0bdf17737048caeb7fac65166740eca5a8929e9255e4 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4RTk2OjJFNjAyMTo5MTg5RDU6QUQ3OEU5OjZBRkY2QTQzIiwidmlzaXRvcl9pZCI6IjQ5ODk1MjIwOTI5MTIyNDEyMTkiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 057b5b471dbf7c04bd5f85d34b45d96ca15568446b030dd5538a2fc92ada2890 |
| hovercard-subject-tag | issue:4144975052 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/UiPath/uipath-python/1498/issue_layout |
| twitter:image | https://opengraph.githubassets.com/a10de84b62f08bae16abcda0ca88ceadedbc7a18085b31c56989aeb9a9b0a36b/UiPath/uipath-python/issues/1498 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/a10de84b62f08bae16abcda0ca88ceadedbc7a18085b31c56989aeb9a9b0a36b/UiPath/uipath-python/issues/1498 |
| og:image:alt | Summary sdk.tasks.create() accepts both app_key and app_name + app_folder_path, but their behaviors diverge in a way that is not documented. Using app_key creates the task but makes it unopenable i... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | AlexBizon |
| hostname | github.com |
| expected-hostname | github.com |
| None | 6d580fc7098c193d7866bf290c4c2b4859a153e87379f44161f35a4495e6b730 |
| turbo-cache-control | no-preview |
| go-import | github.com/UiPath/uipath-python git https://github.com/UiPath/uipath-python.git |
| octolytics-dimension-user_id | 375663 |
| octolytics-dimension-user_login | UiPath |
| octolytics-dimension-repository_id | 925171912 |
| octolytics-dimension-repository_nwo | UiPath/uipath-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 925171912 |
| octolytics-dimension-repository_network_root_nwo | UiPath/uipath-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ec5dd94a369dad6e9ce618a1705cbe3b618a2863 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width