Community Manager

Now Live: Monitor scenario executions with the API

0 replies
17 views
Translate All

Overview

We’ve expanded Workfront Fusion’s API observability so you can monitor scenario executions in far greater detail from your own tools. The October release adds two new execution endpoints, exposes new monitoring fields on existing endpoints, and removes the requirement to scope execution listings to a single scenario. Use these capabilities to build alerts, aggregate errors, and troubleshoot runs without switching to the Fusion UI.

What’s new

Get Execution Details — GET /api/v3/logs/{executionId}/details returns a paginated list of an execution’s activity events (messages, warnings, errors, timestamps) so you can replay the timeline that led to a failure.
Get Execution Bundles — GET /api/v3/logs/{executionId}/bundles returns module-level input and output bundles for a single execution, ordered by cycle → module → operation. Inspect the exact data each module received and produced.
deactivated & deactivationReason — new fields indicate whether an execution deactivated its scenario and explain why, enabling immediate detection of stopped scenarios.
errorCode & errorMessage — fields that surface execution failure causes. Both are filterable so you can quickly find specific failure types (for example, TIMEOUT).
Organization-wide execution search — List Executions no longer requires scenarioId or dlqId, enabling a single call to monitor all executions across your organization.
Module statistics — each item in the modules list now includes package name, module name, and the number of operations performed so you can quickly spot heavy or misbehaving modules.

How to monitor executions with the API (quick)

List failed executions across your org:
```
GET /api/v3/logs?property=status==3
```

Find executions that deactivated scenarios:

GET /api/v3/logs?property=deactivated==true

Filter for a specific error code (example: timeouts):
```
GET /api/v3/logs?property=errorCode==TIMEOUT
```
Inspect the timeline that led to a failure:
```
GET /api/v3/logs/{executionId}/details
```
Examine module inputs and outputs for the execution:
```
GET /api/v3/logs/{executionId}/bundles
```

Why this matters

Faster detection: catch deactivated scenarios immediately and trigger automated remediation or notification flows.
Centralized observability: forward execution errors, codes and messages into your existing monitoring, SIEM or incident management systems.
Deeper troubleshooting: replay event timelines and inspect exact module bundles so engineers can diagnose root causes without manually stepping through the Fusion UI.
Org-level monitoring: one API call can now surface high-level execution trends and failures across all scenarios in your organization.

Getting started

Review your API credentials and ensure they have permissions to read logs and executions for the organization you intend to monitor.
Use the List Executions endpoint to build dashboards or periodic scans for failures and deactivations. Start with queries like status==3 or deactivated==true.
When you spot an execution of interest, call /api/v3/logs/{executionId}/details to get the event timeline and /api/v3/logs/{executionId}/bundles to retrieve module inputs/outputs.
Map errorCode, errorMessage, deactivated, and deactivationReason into your alerting rules to reduce mean time to detection and resolution.

Troubleshooting tips

Missing fields: If you don’t see the new fields, verify you’re calling the v3 API and that your tenant has the October release features enabled.
Large bundle payloads: Execution bundles can be large for high-throughput scenarios. Page results and stream or chunk responses in your consumer to avoid memory issues.
Rate limits: If you poll frequently for organization-wide executions, implement backoff and batching to stay within API rate limits.
Correlating runs: Use executionId, scenarioId, cycle timestamps, and module names to tie execution data back to your internal tracing or logs for complete incident context.

Related October release items

Validate blueprints before creating scenarios
Clone connections between teams
Connector/key/hook assets (icons) for custom UIs
Incomplete execution management (delete, update blueprint/failing module, retrieve failed bundle)
Expanded resource management and new user/team/org endpoints

Documentation & support

See the full changes in the API changelog and the endpoint reference for request/response examples and pagination details:

Feedback and support

Tell us how you’re using the new execution monitoring endpoints or suggest improvements (examples: webhook notifications for deactivations, richer error classification, Compact bundle diffs) by:

Posting in the Experience League Community API thread.
Opening a support ticket via the Admin Console Support portal for account- or configuration-specific questions.

Start integrating execution details into your monitoring workflows today to reduce investigation time and improve operational visibility across your Fusion organization.