System Events
Get Veza platform events, including notifications and integration logs.
GET /api/preview/events
GET /api/preview/events/export
Event objects represent Veza platform activity, including integration parsing, notification activity, and user logins. You can list events that match a filter (such as a category or severity), or export a continuous list for integration with an external monitoring system,
For logging Veza API activity, see Audit Log API.
List events
Returns an array of Veza platform events. If a filter is specified, the endpoint only returns events matching the SCIM filter expression. This can get events with a matching category or severity, for example:
GET /api/preview/events?page_size=10&filter=category+eq+"INTEGRATIONS"+and+timestamp+ge+"2023-04-17T22:29:22.440Z"
Veza API key for authentication. Generate keys in Administration > API Keys.
OK
Default error response
Export events
Returns a paginated list of platform events, intended for exporting a continuous log into an external system.
The export endpoint can return the error code ResourceExhaused. When encountered, wait for one minute before retrying the request.
Veza API key for authentication. Generate keys in Administration > API Keys.
OK
Default error response
To capture events when they become available without skipping any entries, first make call with a persisted_at GE "TIMESTAMP" filter:
Use the next_page_token in the response to continuously call the next page:
Example response:
Veza event schema
id
Unique identifier for the event
d95ccc9c-9051-4ef7-9147-124a16409baa
timestamp
Timestamp when the event occurred
2023-05-18T14:23:35.151842912Z
category
Category of the event
SYSTEM, INTEGRATIONS, RULE, TAG, NOTIFICATION
severity
Severity level of the event
INFO, WARNING, ERROR
name
Title of the event
Tagging request failed
message
Descriptive message for the event
Tagging request failed for node test1
provider_id
Provider data source unique identifier
e88f5d72-6f79-41d1-99e3-8777e1727311
entity
Type of entity related to the event
DATASOURCE, PROVIDER, RULE, TAG, NOTIFICATION
entity_id
Unique identifier for the entity
e88f5d72-6f79-41d1-99e3-8777e1727311
entity_name
Name of entity related to the event
SYSTEM_resource_managers:500008
error
Error details
See "error object structure"
event_type
Type or category of the event
Tagging request failed
Error object structure:
message: Error messagemetadata: Additional metadata for the failed request.reason: Reason for the errorresolution: Details to prevent the errorrequest_id: Unique identifier for the failed request
Event types
The following table describes all Veza platform event types, organized by functional area:
Integration Events
OUTDATED_AWS_EXTRACTION_POLICY
AWS extraction policy requires updating
DATASOURCE_PARSED
Data source metadata successfully processed
DATASOURCE_PARSED_NO_CHANGE
Data source parsed but no changes detected
DATASOURCE_EXTRACTED
Data source extraction completed successfully
DATASOURCE_EXTRACTED_NO_CHANGE
Extraction completed but Access Graph unchanged
DATASOURCE_REGISTERED
New data source registered in Veza
DATASOURCE_REMOVED
Data source removed from Veza
DISCOVERY_FAILED
Integration discovery process failed
DISCOVERY_SUCCESS
Integration discovery completed successfully
OAA_PUSH
Open Authorization API data push event
PROVIDER_CONFIG_CHANGED
Integration provider configuration modified
AUDITLOG_EXTRACTED
Audit log data extracted from integration
INSIGHT_POINT_UNAVAILABLE
Insight Point connector offline (all instances unavailable)
INSIGHT_POINT_DEGRADED
Insight Point operating with reduced functionality (some instances unavailable/out of sync)
INSIGHT_POINT_INSTANCE_OUT_OF_SYNC
Insight Point instance has time drift issues (time not synchronized with control plane)
SNOWFLAKE_EXPORT
Data export to Snowflake completed
User Management Events
USER_LOGIN
User successfully authenticated
USER_LOGOUT
User session terminated
USER_CREATED
New user account created
USER_DELETED
User account permanently removed
USER_ENABLED
User account activated or enabled
USER_DISABLED
User account deactivated
USER_EMAIL_UPDATED
User email address changed
USER_ROLES_UPDATED
User role assignments modified
USER_PASSWORD_FORCED_RESET
Administrator forced password reset
USER_PASSWORD_RESET
User password reset initiated
USER_AUTH_FACTORS_RESET
Authentication factors reset
USER_AUTH_FACTORS_FORCED_RESET
Administrator forced MFA reset
API Key Management Events
API_KEY_CREATED
New API key generated
API_KEY_UPDATED
API key properties modified
API_KEY_DELETED
API key permanently removed
API_KEY_REVOKED
API key temporarily disabled
API_KEY_REINSTATED
Previously revoked API key reactivated
System and Infrastructure Events
RULE_NOTIFICATION_FAILED
Alert rule notification delivery failed
TAGGING_REQUEST_FAILED
Entity tagging operation failed
EMAIL_NOTIFICATION
System email notification sent
EMAIL_SENT
Email delivery confirmed
DOMAIN_NOT_IN_ALLOWLIST
External domain access blocked
WEBHOOK_NOT_IN_ALLOWLIST
Webhook URL blocked by allowlist
Access Review Events
ACCESS_REVIEW_CONFIGURATION_MODIFIED
Review configuration settings changed
EMPTY_ACCESS_REVIEW_CLEANED_UP
Empty review automatically removed
Auth Changes Events
MFA_ENABLED
Multi-factor authentication enabled
MFA_DISABLED
Multi-factor authentication disabled
SCIM_PROVISIONING_ENABLED
SCIM provisioning enabled
SCIM_PROVISIONING_DISABLED
SCIM provisioning disabled
SSO_REDIRECT_ENABLED
SSO redirect enabled
SSO_REDIRECT_DISABLED
SSO redirect disabled
IDP_MANAGED_ROLES_ENABLED
IdP-managed roles enabled
IDP_MANAGED_ROLES_DISABLED
IdP-managed roles disabled
LOCAL_ACCOUNTS_ENABLED
Local account authentication enabled
LOCAL_ACCOUNTS_DISABLED
Local account authentication disabled
AUTH_PROVIDER_ENABLED
Authentication provider enabled
AUTH_PROVIDER_DISABLED
Authentication provider disabled
Event retention
Veza retains system events for one month. When requesting events outside that range, the response will have a field error message indicating the oldest valid timestamp:
Pagination
Responses will contain a next_page_token when more events are available. Include this page_token in the request query to get the next batch of results.
If no page size is specified, the default is 1,000. The maximum page size is currently 10,000 records.
Last updated
Was this helpful?
