feat: create external trigger entities

Author: radu-mocanu

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.6.0"
+version = "2.6.1"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

src/uipath/platform/resume_triggers/_enums.py

@@ -2,6 +2,8 @@
 
 from enum import Enum
 
+from pydantic import BaseModel, Field
+
 
 class PropertyName(str, Enum):
     """UiPath trigger property names."""
@@ -16,3 +18,23 @@ class TriggerMarker(str, Enum):
     """
 
     NO_CONTENT = "NO_CONTENT"
+
+
+class ExternalTriggerType(str, Enum):
+    """External trigger types."""
+
+    DEEP_RAG = "deepRag"
+    BATCH_TRANSFORM = "batchTransform"
+    IXP_EXTRACTION = "ixpExtraction"
+
+
+class ExternalTrigger(BaseModel):
+    """Model representing an external trigger entity."""
+
+    type: ExternalTriggerType
+    external_id: str = Field(alias="externalId")
+
+    model_config = {
+        "validate_by_name": True,
+        "validate_by_alias": True,
+    }

src/uipath/platform/resume_triggers/_protocol.py

@@ -28,6 +28,7 @@
     CreateTask,
     DocumentExtraction,
     InvokeProcess,
+    UiPathConfig,
     WaitBatchTransform,
     WaitDeepRag,
     WaitDocumentExtraction,
@@ -42,7 +43,12 @@
     OperationNotCompleteException,
 )
 from uipath.platform.orchestrator.job import JobState
-from uipath.platform.resume_triggers._enums import PropertyName, TriggerMarker
+from uipath.platform.resume_triggers._enums import (
+    ExternalTrigger,
+    ExternalTriggerType,
+    PropertyName,
+    TriggerMarker,
+)
 
 
 def _try_convert_to_json_format(value: str | None) -> Any:
@@ -371,6 +377,19 @@ async def create_trigger(self, suspend_value: Any) -> UiPathResumeTrigger:
             ) from e
         return resume_trigger
 
+    async def _create_external_trigger(self, external_trigger: ExternalTrigger):
+        """Creates an external trigger in orchestrator."""
+        # only create external trigger entities for non-debug runs
+        if not UiPathConfig.job_key:
+            return
+
+        uipath = UiPath()
+        await uipath.api_client.request_async(
+            method="POST",
+            url="orchestrator_/api/JobTriggers/SaveExternalTrigger",
+            json=external_trigger.model_dump(by_alias=True),
+        )
+
     def _determine_trigger_type(self, value: Any) -> UiPathResumeTriggerType:
         """Determines the resume trigger type based on the input value.
 
@@ -477,6 +496,13 @@ async def _handle_deep_rag_job_trigger(
             )
             if not deep_rag:
                 raise Exception("Failed to start deep rag")
+
+            await self._create_external_trigger(
+                ExternalTrigger(
+                    type=ExternalTriggerType.DEEP_RAG, external_id=deep_rag.id
+                )
+            )
+
             resume_trigger.item_key = deep_rag.id
 
     async def _handle_batch_rag_job_trigger(
@@ -506,6 +532,14 @@ async def _handle_batch_rag_job_trigger(
             )
             if not batch_transform:
                 raise Exception("Failed to start batch transform")
+
+            await self._create_external_trigger(
+                ExternalTrigger(
+                    type=ExternalTriggerType.BATCH_TRANSFORM,
+                    external_id=batch_transform.id,
+                )
+            )
+
             resume_trigger.item_key = batch_transform.id
 
     async def _handle_ixp_extraction_trigger(
@@ -531,6 +565,14 @@ async def _handle_ixp_extraction_trigger(
             )
             if not document_extraction:
                 raise Exception("Failed to start document extraction")
+
+            await self._create_external_trigger(
+                ExternalTrigger(
+                    type=ExternalTriggerType.IXP_EXTRACTION,
+                    external_id=document_extraction.operation_id,
+                )
+            )
+
             resume_trigger.item_key = document_extraction.operation_id
 
             # add project_id and tag to the payload dict (needed when reading the trigger)