list_workflow_events
Retrieve workflow automation triggers to initiate compliance processes. Access system events for assessment completions and form submissions, plus custom events for external integrations and manual execution.
Instructions
Retrieve available workflow events that can trigger workflows.
Events are the starting points of workflows. Each event has a payload that provides data to subsequent workflow nodes. Events are categorized into two types:
System Events: Automatically triggered by the system when specific actions occur. Examples include:
Assessment run completed
Form submitted
Scheduled time-based triggers
Custom Events: Manually triggered events that can be used to:
Trigger workflows from within other workflows
Integrate with external systems
Enable manual workflow execution
Returns: - systemEvents (List[WorkflowEventVO]): A list of system events that are automatically triggered. - id (str) - categoryId (str) - desc (str) - displayable (str) - payload [List[WorkflowPayloadVO]] - status (str) - type (str) - customEvents (List[WorkflowEventVO]): A list of custom events that can be manually triggered. - id (str) - categoryId (str) - desc (str) - displayable (str) - payload [List[WorkflowPayloadVO]] - status (str) - type (str) - error (Optional[str]): An error message if any issues occurred during retrieval.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| systemEvents | No | ||
| customEvents | No | ||
| error | No |