Integration Jobs

List, inspect, export, and push results for integration-level job events in lifecycle management

Integration job events are the lowest-level execution records in Veza Lifecycle Management. Each job event represents a single call to an integration agent—for example, creating a user in Active Directory, adding a group membership in Okta, or sending a webhook to ServiceNow.

These APIs correspond to the Integration Jobs tab on the Activity Log page in the Veza UI.

Integration Job APIs help you:

• Debug integration-level failures with full request/response payloads

• Track which specific agent calls succeeded or failed

• Push results back from webhook-based integrations

• Export job event data for compliance and troubleshooting

Endpoints

Method	Endpoint	Description
GET	List Job Events	Retrieve a paginated list of integration job events
GET	Get Job Event	Retrieve a single job event with full request/result payloads
POST	Export Job Events	Export job events to a downloadable file
POST	Push Job Result	Push a result back from a webhook-based integration

Key Concepts

Job Request and Result

Each job event can include detailed request and result payloads:

• JobRequest: Contains the target data source configuration, input entities, action type, and action-specific configuration

• JobResult: Contains the job outcome including output entities, error messages, and flags indicating whether changes were made

Use details=true on the List endpoint or the Get endpoint to retrieve these payloads.

Event Source

The event_source field indicates what initiated the job:

Value	Description
POLICY	Job was triggered by an LCM Policy workflow
ACCESS_PLAN	Job was triggered by an Access Plan

List Job Events

Endpoint

GET /api/private/lifecycle_management/action_job_events

Description

Retrieve a paginated list of integration job events. Set the details query parameter to true to include the full job request and result payloads in the response.

Filterable Fields

Field	Operators	Description
state	eq	Current execution state
job_id	eq, co	Job ID
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
event_source	eq	Source (POLICY or ACCESS_PLAN)
event_source_id	eq	Source ID (policy ID or access plan ID)
extraction_event	eq	Extraction event ID
extraction_event_type	eq, ne	Extraction type (case-insensitive)
started_at	gt, ge, lt, le	Job start time
completed_at	gt, ge, lt, le	Job completion time
created_at	gt, ge, lt, le	Job creation time
any_changes	eq	Whether the job made any changes
events_created	eq	Number of events produced

API Reference

List Integration Job Events

get

Retrieve a paginated list of action job events. Each job event represents a single integration-level job dispatched as part of an action—for example, a call to an Active Directory agent to create a user. Corresponds to the "Integration Jobs" tab in the Activity Log UI. Set details=true to include the full job request and result payloads.

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), job_id (eq, co), policy_task (eq), action_name (eq, co — case-insensitive), extraction_event (eq), any_changes (eq), events_created (eq), action_type (eq), identity_id (eq, co, sw, ew), identity_name (eq, co, sw, ew), received_response_at (eq, co, sw, ew), extraction_event_type (eq, ne — case-insensitive), event_source (eq), event_source_id (eq), created_at (gt, ge, lt, le), policy_id (eq), workflow_name (eq, co). Example: state eq "ERRORED" and action_type eq "MANAGE_RELATIONSHIPS".

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

detailsbooleanOptional

Responses

200

OK

application/json

next_page_tokenstringOptional

has_morebooleanOptional

default

Default error response

application/json

get

/api/private/lifecycle_management/action_job_events

HTTPcURLJavaScriptPython

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

{
  "values": [
    {
      "started_at": "2026-02-26T19:20:21.983Z",
      "completed_at": "2026-02-26T19:20:21.983Z",
      "state": 1,
      "job_id": "text",
      "policy_task": "text",
      "action_name": "text",
      "extraction_event": "text",
      "error_message": "text",
      "any_changes": true,
      "events_created": 1,
      "action_type": 1,
      "identity_id": "text",
      "identity_name": "text",
      "request": {
        "job_id": "text",
        "data_source": {
          "id": "text",
          "external_id": "text",
          "agent_type": "text",
          "data_provider_id": "text",
          "data_source_config": {
            "@type": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "data_provider_type": 1,
          "data_provider_secret_refs": [
            {
              "id": "text",
              "secret_id": "text",
              "vault_id": "text",
              "vault": {
                "id": "text",
                "name": "text",
                "vault_provider": "text",
                "insight_point_id": "text",
                "deleted": true
              }
            }
          ]
        },
        "input_entities": [
          {
            "entity_type": "text",
            "entity_id": "text",
            "attributes": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "assigned_to_entity_type": "text",
            "assigned_to_entity_id": "text",
            "entity_name": "text",
            "error_message": "text",
            "unique_identifiers": [
              "text"
            ],
            "datasource_id": "text"
          }
        ],
        "action_type": 1,
        "action_config": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "action_job_id": "text",
        "action_name": "text",
        "identity_id": "text",
        "stop_on_error": true,
        "ttl": "text",
        "has_changed_attributes": true,
        "changed_attributes": [
          "text"
        ]
      },
      "result": {
        "job_id": "text",
        "error_message": "text",
        "output_entities": [
          {
            "entity_type": "text",
            "entity_id": "text",
            "attributes": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "assigned_to_entity_type": "text",
            "assigned_to_entity_id": "text",
            "entity_name": "text",
            "error_message": "text",
            "unique_identifiers": [
              "text"
            ],
            "datasource_id": "text"
          }
        ],
        "action_type": 1,
        "action_result": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "info_messages": [
          "text"
        ],
        "any_changes": true,
        "any_created": true,
        "should_stop_next_job": true
      },
      "extraction_event_type": 1,
      "event_source": 1,
      "event_source_id": "text",
      "created_at": "2026-02-26T19:20:21.983Z",
      "policy_id": "text",
      "workflow_name": "text"
    }
  ],
  "next_page_token": "text",
  "has_more": true
}

Request Examples

List errored jobs with details:

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

List jobs for a specific workflow task:

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/action_job_events?filter=policy_task%20eq%20%22task-abc-123%22" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Get Job Event

Endpoint

GET /api/private/lifecycle_management/action_job_events/{job_id}

Description

Retrieve a single job event by its job ID. The response always includes the full request and result payloads, providing complete visibility into what was sent to the integration agent and what came back.

API Reference

Get Integration Job Event

get

Retrieve a single action job event by its job ID. Returns the full ActionJobEvent object along with the JobResult and JobRequest payloads, which contain the detailed input entities, action configuration, output entities, and any error messages from the integration agent.

Authorizations

bearerAuth

AuthorizationstringRequired

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

Path parameters

job_idstringRequired

Responses

200

OK

application/json

default

Default error response

application/json

get

/api/private/lifecycle_management/action_job_events/{job_id}

HTTPcURLJavaScriptPython

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

{
  "value": {
    "started_at": "2026-02-26T19:20:21.983Z",
    "completed_at": "2026-02-26T19:20:21.983Z",
    "state": 1,
    "job_id": "text",
    "policy_task": "text",
    "action_name": "text",
    "extraction_event": "text",
    "error_message": "text",
    "any_changes": true,
    "events_created": 1,
    "action_type": 1,
    "identity_id": "text",
    "identity_name": "text",
    "request": {
      "job_id": "text",
      "data_source": {
        "id": "text",
        "external_id": "text",
        "agent_type": "text",
        "data_provider_id": "text",
        "data_source_config": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "data_provider_type": 1,
        "data_provider_secret_refs": [
          {
            "id": "text",
            "secret_id": "text",
            "vault_id": "text",
            "vault": {
              "id": "text",
              "name": "text",
              "vault_provider": "text",
              "insight_point_id": "text",
              "deleted": true
            }
          }
        ]
      },
      "input_entities": [
        {
          "entity_type": "text",
          "entity_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "assigned_to_entity_type": "text",
          "assigned_to_entity_id": "text",
          "entity_name": "text",
          "error_message": "text",
          "unique_identifiers": [
            "text"
          ],
          "datasource_id": "text"
        }
      ],
      "action_type": 1,
      "action_config": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "action_job_id": "text",
      "action_name": "text",
      "identity_id": "text",
      "stop_on_error": true,
      "ttl": "text",
      "has_changed_attributes": true,
      "changed_attributes": [
        "text"
      ]
    },
    "result": {
      "job_id": "text",
      "error_message": "text",
      "output_entities": [
        {
          "entity_type": "text",
          "entity_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "assigned_to_entity_type": "text",
          "assigned_to_entity_id": "text",
          "entity_name": "text",
          "error_message": "text",
          "unique_identifiers": [
            "text"
          ],
          "datasource_id": "text"
        }
      ],
      "action_type": 1,
      "action_result": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "info_messages": [
        "text"
      ],
      "any_changes": true,
      "any_created": true,
      "should_stop_next_job": true
    },
    "extraction_event_type": 1,
    "event_source": 1,
    "event_source_id": "text",
    "created_at": "2026-02-26T19:20:21.983Z",
    "policy_id": "text",
    "workflow_name": "text"
  },
  "result": {
    "job_id": "text",
    "error_message": "text",
    "output_entities": [
      {
        "entity_type": "text",
        "entity_id": "text",
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "assigned_to_entity_type": "text",
        "assigned_to_entity_id": "text",
        "entity_name": "text",
        "error_message": "text",
        "unique_identifiers": [
          "text"
        ],
        "datasource_id": "text"
      }
    ],
    "action_type": 1,
    "action_result": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "info_messages": [
      "text"
    ],
    "any_changes": true,
    "any_created": true,
    "should_stop_next_job": true
  },
  "request": {
    "job_id": "text",
    "data_source": {
      "id": "text",
      "external_id": "text",
      "agent_type": "text",
      "data_provider_id": "text",
      "data_source_config": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "data_provider_type": 1,
      "data_provider_secret_refs": [
        {
          "id": "text",
          "secret_id": "text",
          "vault_id": "text",
          "vault": {
            "id": "text",
            "name": "text",
            "vault_provider": "text",
            "insight_point_id": "text",
            "deleted": true
          }
        }
      ]
    },
    "input_entities": [
      {
        "entity_type": "text",
        "entity_id": "text",
        "attributes": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "assigned_to_entity_type": "text",
        "assigned_to_entity_id": "text",
        "entity_name": "text",
        "error_message": "text",
        "unique_identifiers": [
          "text"
        ],
        "datasource_id": "text"
      }
    ],
    "action_type": 1,
    "action_config": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "action_job_id": "text",
    "action_name": "text",
    "identity_id": "text",
    "stop_on_error": true,
    "ttl": "text",
    "has_changed_attributes": true,
    "changed_attributes": [
      "text"
    ]
  }
}

Request Example

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/action_job_events/job-abc-123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Export Job Events

Endpoint

POST /api/private/lifecycle_management/action_job_events:export

Description

Export integration job events matching a filter to a downloadable CSV file.

API Reference

Export Integration Job Events

post

Export action job events to a downloadable file. Accepts the same filter and ordering parameters as the List Action Job 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

detailsbooleanOptional

Responses

200

OK

application/json

idstringOptional

default

Default error response

application/json

post

/api/private/lifecycle_management/action_job_events:export

HTTPcURLJavaScriptPython

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

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

{
  "id": "text"
}

Request Example

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

Push Job Result

Endpoint

POST /api/private/lifecycle_management/action_job_events/{job_id}:push

Description

Push a job result back to Veza after an external integration has completed processing. This endpoint is used by webhook-based integrations (such as ServiceNow, custom REST actions, or any integration using the SEND_REST_PAYLOAD action type) that receive job requests via webhook and must report results asynchronously.

Integration requirement: The webhook payload sent to your external system includes a return_post_url field. Your system should POST the result to that URL, which routes to this endpoint.

Requires admin, operator, or oaa_push role.

API Reference

Push Integration Job Result

post

Push a job result back to Veza after an external integration has completed processing. Used by webhook-based integrations (such as ServiceNow or custom REST actions) that receive job requests via webhook and must report results asynchronously. Requires admin, operator, or oaa_push role.

Authorizations

bearerAuth

AuthorizationstringRequired

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

Path parameters

job_idstringRequired

Body

application/json

job_idstringOptional

error_messagestringOptional

action_typeinteger · enumOptional

Type of action and the result that corresponds to that action

info_messagesstring[]Optional

any_changesbooleanOptional

any_createdbooleanOptional

should_stop_next_jobbooleanOptional

Responses

200

OK

application/json

objectOptional

default

Default error response

application/json

post

/api/private/lifecycle_management/action_job_events/{job_id}:push

HTTPcURLJavaScriptPython

POST /api/private/lifecycle_management/action_job_events/{job_id}:push HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 488

{
  "job_id": "text",
  "error_message": "text",
  "output_entities": [
    {
      "entity_type": "text",
      "entity_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "assigned_to_entity_type": "text",
      "assigned_to_entity_id": "text",
      "entity_name": "text",
      "error_message": "text",
      "unique_identifiers": [
        "text"
      ],
      "datasource_id": "text"
    }
  ],
  "action_type": 1,
  "action_result": {
    "@type": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "info_messages": [
    "text"
  ],
  "any_changes": true,
  "any_created": true,
  "should_stop_next_job": true
}

{}

Request Example

curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/action_job_events/job-abc-123:push" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "value": {
      "job_id": "job-abc-123",
      "action_type": "SEND_REST_PAYLOAD",
      "output_entities": [],
      "any_changes": true,
      "any_created": false
    }
  }'

Authentication

All Integration Job API requests require authentication. See API Authentication for details.

Related Documentation

• Activity Log

• Conditions and Actions

• Triggered Workflows

• Workflow Actions

• Events