Workflow Actions

List, inspect, and export workflow action events from lifecycle management policy executions

Workflow action events represent the execution of individual actions within a triggered workflow task. Each action corresponds to a configured step in a policy workflow—such as synchronizing identities, managing group memberships, or sending notifications.

These APIs correspond to the Workflow Actions tab on the Activity Log page in the Veza UI.

Workflow Action APIs help you:

• Drill into specific action executions within a workflow task

• Identify which action step failed when a workflow errors

• Track how many integration jobs each action dispatched

• Export action event history for auditing

Endpoints

Method	Endpoint	Description
GET	List Action Events	Retrieve a paginated list of action events
GET	Get Action Event	Retrieve a single action event by task ID and action name
POST	Export Action Events	Export action events to a downloadable file

Key Concepts

Action Types

The action_type field indicates what operation was performed:

Value	Description
NONE	No action type specified
SYNC_IDENTITIES	Synchronize identity attributes to a target system
MANAGE_RELATIONSHIPS	Add or remove identity from groups, roles, or entitlements
CREATE_EMAIL	Create an email address for the identity
DEPROVISION_IDENTITY	Deprovision (disable) an identity
ACCESS_PLAN	Action controlled via an Access Plan
WRITE_BACK_EMAIL	Write back an email address to an HRIS system
PAUSE	Pause workflow execution for a configured duration
SEND_NOTIFICATION	Send a notification
CUSTOM_ACTION	Execute a custom action (e.g., write ServiceNow table)
CREATE_ENTITLEMENT	Create a role or group in the target system
CREATE_ACCESS_REVIEW	Create an access review campaign
RESET_PASSWORD	Reset the identity's password
DELETE_IDENTITY	Permanently delete an identity
SEND_REST_PAYLOAD	Send a formatted REST API payload

Action States

Action events use the same state model as workflow tasks (INITIAL, RUNNING, COMPLETED, ERRORED, SKIPPED, etc.). See Triggered Workflows for the full state reference.

List Action Events

Endpoint

GET /api/private/lifecycle_management/action_events

Description

Retrieve a paginated list of action events across all policies and workflows. Supports SCIM-style filtering, ordering, and pagination.

Filterable Fields

Field	Operators	Description
state	eq	Current execution state
policy_task	eq	Parent workflow task ID
action_name	eq, co	Action name (case-insensitive)
action_type	eq	Type of action executed
policy_id	eq	Policy ID
workflow_name	eq, co	Workflow name
identity_id	eq, co, sw, ew	Identity ID
identity_name	eq, co, sw, ew	Identity name (case-insensitive)
started_at	gt, ge, lt, le	Action start time
completed_at	gt, ge, lt, le	Action completion time
any_changes	eq	Whether the action made any changes
extraction_event	eq	Extraction event ID
jobs_started	eq	Number of jobs dispatched

API Reference

List Workflow Action Events

get

Retrieve a paginated list of action events. Each action event represents the execution of a single action (e.g., Sync Identities, Manage Relationships) within a triggered workflow task. Corresponds to the "Workflow Actions" tab in the Activity Log UI.

Authorizations

bearerAuth

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Query parameters

filterstringOptional

SCIM-style filter expression. Filterable fields: started_at (gt, ge, lt, le), completed_at (gt, ge, lt, le), state (eq), policy_task (eq), action_name (eq, co — case-insensitive), action_type (eq), extraction_event (eq), jobs_started (eq), any_changes (eq), policy_id (eq), workflow_name (eq, co), identity_id (eq, co, sw, ew), identity_name (eq, co, sw, ew — case-insensitive). Example: state eq "ERRORED" and action_type eq "SYNC_IDENTITIES".

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

OK

application/json

next_page_tokenstringOptional

has_morebooleanOptional

default

Default error response

application/json

get

/api/private/lifecycle_management/action_events

HTTPcURLJavaScriptPython

GET /api/private/lifecycle_management/action_events HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "started_at": "2026-02-26T22:42:10.276Z",
      "completed_at": "2026-02-26T22:42:10.276Z",
      "state": 1,
      "policy_task": "text",
      "action_name": "text",
      "action_type": 1,
      "extraction_event": "text",
      "jobs_started": 1,
      "any_changes": true,
      "policy_id": "text",
      "workflow_name": "text",
      "identity_id": "text",
      "identity_name": "text"
    }
  ],
  "next_page_token": "text",
  "has_more": true
}

Request Example

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/action_events?filter=state%20eq%20%22ERRORED%22&page_size=50" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Action Event

Endpoint

GET /api/private/lifecycle_management/action_events/{workflow_task}/{action_name}

Description

Retrieve a single action event by specifying the parent workflow task ID and the action name. The workflow_task path parameter corresponds to the policy_task field in the response (a historical naming convention).

API Reference

Get Workflow Action Event

get

Retrieve a single action event by its workflow task ID (historically called "policy_task") and action name. Returns the full ActionEvent object including state, timing, action type, and identity details.

Authorizations

bearerAuth

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Path parameters

workflow_taskstringRequired

"workflow_task" is referred to as "policy_task" (because that was the historical name)

action_namestringRequired

Responses

200

OK

application/json

default

Default error response

application/json

get

/api/private/lifecycle_management/action_events/{workflow_task}/{action_name}

HTTPcURLJavaScriptPython

GET /api/private/lifecycle_management/action_events/{workflow_task}/{action_name} HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "started_at": "2026-02-26T22:42:10.276Z",
    "completed_at": "2026-02-26T22:42:10.276Z",
    "state": 1,
    "policy_task": "text",
    "action_name": "text",
    "action_type": 1,
    "extraction_event": "text",
    "jobs_started": 1,
    "any_changes": true,
    "policy_id": "text",
    "workflow_name": "text",
    "identity_id": "text",
    "identity_name": "text"
  }
}

Request Example

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/action_events/task-abc-123/Sync%20AD%20Attributes" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Export Action Events

Endpoint

POST /api/private/lifecycle_management/action_events:export

Description

Export action events matching a filter to a downloadable CSV file. The request body wraps the same filter and ordering parameters used by the List endpoint.

API Reference

Export Workflow Action Events

post

Export action events to a downloadable file. Accepts the same filter and ordering parameters as the List Action Events endpoint. Returns an export job reference that can be polled for completion.

Authorizations

bearerAuth

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Query parameters

formatinteger · enumOptional

Body

application/json

filterstringOptional

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

OK

application/json

idstringOptional

default

Default error response

application/json

post

/api/private/lifecycle_management/action_events:export

HTTPcURLJavaScriptPython

POST /api/private/lifecycle_management/action_events:export HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "filter": "text",
  "order_by": "text",
  "page_size": 1,
  "page_token": "text"
}

{
  "id": "text"
}

Request Example

curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/action_events:export" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "body": {
      "filter": "action_type eq \"MANAGE_RELATIONSHIPS\"",
      "order_by": "started_at desc"
    },
    "format": "CSV"
  }'

Authentication

All Workflow Action API requests require authentication. See API Authentication for details.

Related Documentation

• Activity Log

• Conditions and Actions

• Triggered Workflows

• Integration Jobs

• Events