Send Apono access request data to your internal systems with event-triggered HTTP messages
This reference describes each of the properties of the webhook payload schema.
The payload schema defines the structure of the data that you can pass in the webhook payload. Apono uses the Handlebars templating language to format expressions for certain data fields.
event_type string
Type of audit log event
event_time string
Date the event occurred
data object
timestamp string
Date and time the event occurred
action string
Event performed, such as creating, editing, or deleting an item
actor_id string
Email address of the user who performed the action
actor_name string
Full name of the user who performed the action
actor_type string
Type of user who performed the action
source string
Location where the action originated
Possible Values:
API
integration
Terraform
web application
target_id string
Unique identifier of the object affected by the action
target_type string
Type of object affected by the action
Possible Values:
access flow
bundle
integration
target_name string
Friendly name of the object affected by the action
current_target_object object
Updated details of the object affected by the action
IMPORTANT: The webhook will return all data within this object. Specific values within a target object cannot be targeted. The following details of each target are provided for information purposes only.
Target Objects:
previous_target_object object
Previous details of the object affected by the action
IMPORTANT: The webhook will return all data within this object. Specific values within a target object cannot be targeted. The following details of each target are provided for information purposes only.
Target Objects:
id string
Unique identifier of the access flow
name string
Friendly name of the access flow
active boolean
Status of the access flow Possible Values:
true
false
revoke_after_in_sec integer
Access duration (in seconds) granted for the resources within the access flow
trigger string | object
Event associated with the access flow
grantees object
access_targets object
approver_policy object
Identities authorized to approve the access flow request
settings object
labels object
created_date string
Creation date of the access flow
updated_date string
Most recent modified date of the access flow
logical_operator string
Logical operator applied to the attribute_filters objects
attribute_filters object
operator string
Comparative operator relating the attribute_type_id and attribute_value
attribute_type_id string
Type of grantee
Possible Values:
group
user
attribute_value [string]
Unique identifier of the grantee
integration object
bundle object
The bundle_id is the sole property of this object.
saved_query object
resource_integration_id string
Unique identifier of the resource
resource_type string
Type of resource
resource_tag_restrictors object
Resources excluded from the integration
permissions object
Permissions granted to the resource
groups_operator string
Logical operator applied to the condition_groups objects
condition_groups object
logical_operator string
Logical operator applied to the conditions objects
conditions object
attribute_condition object
request_context_based_attribution_filter object
operator string
Comparative operator relating the attribute_type_id and attribute_value
attribute_type_id string
Type of approver
attribute_value [string]
Unique identifier of the approver
attribute_type_id string
Type of approver
integration_id string
Identifying value of the associated integration
require_approver_justification boolean
require_justification boolean
approver_cannot_approve_himself boolean
require_mfa boolean
account_id string
Unique identifier of the account
account_name string
Friendly name of the account
enable_flow_failure_notifications boolean
Notifications sent to admins about access flow failures
credential_rotation_period_in_days integer
Number of days after which the credentials must be rotated
inactive_user_retention_in_days integer
integrations_updates_notifications boolean
Email notifications sent to admins about integration status updates
require_duration_for_access_request boolean
Requires the requester to specify duration of access
id string
Unique identifier of the activity report
name string
Friendly name of the activity report
active boolean
Status of the activity report
filters object
Selected report filters
start_date string
Absolute start date of the report window
end_date string
Absolute end date of the report window
period object
Relative time of the report window
time_zone string
Time zone of the report
fields [string]
Data fields included in the report
schedule object
Generation frequency, format, and recipients of the report
created_date string
Creation date of the report
updated_date string
Most recent modified date of the report
id string
Unique identifier of the bundle
name string
Friendly name of the bundle
create_date string
Creation date of the bundle
access_targets object
id string
Unique identifier of the resource
name string
Friendly name of the resource
type string
Type of resource
id string
Unique identifier of the integration
name string
Friendly name of the integration
type string
Type of integration
status string
Status of the integration
connector_id string
Unique identifier of the connector used for the integration
parent_integration_id string
Unique identifier of the parent integration associated with this integration
connected_resource_types [string]
List of resources associated with the integration
params object
Parameters associated with the integration
custom_instructions_access_message string
Instructions explaining how to access this integration's resources
last_sync_date string (date-time)
Most recent date that Apono synced the integration
secret_config object
id string
Unique identifier of the user
email string
Email address of the user
first_name string
First name of the user
last_name string
Last name of the user
active boolean
Status of the user
roles [string]
Role-based access assigned to the user
id string
Unique identifier of the webhook
name string
Friendly name of the webhook
active boolean
Status of the webhook
triggers [string]
Associated webhook triggers
Possible Values:
AuditEventTriggered
Manual
RequestCreated
RequestApproved
RequestRejected
RequestGranted
RequestExpired
RequestFailed
created_date string (date-time)
Creation date of the webhook Example: 2023-10-01T12:34:56Z
updated_date string (date-time)
Most recent modified date of the webhook Example: 2023-10-03T1:32:57Z
Field containing an embedded object with contextual information about the triggering event See:
Identities for whom access is requested See:
Integrations, bundles, or access scopes to which access will be given See:
applied to the access flow
Identifies access flows for streamlined organization and use See:
List of grantees See:
Integration definition See:
Unique identifier of the , contained within the bundle_id property
Unique identifier of the , contained within the saved_query_id property
The saved_query_id is the sole property of this object.
Grouped list of approvers See:
List of individual approver criteria See:
Attributes of a specific approver See:
Attributes of a specific approver based on context See:
Indicates if approvers are required to enter a justification for approving or rejecting a request See:
Indicates if grantees are required to enter a justification for their requests See:
Indicates if users can approve their own access See:
Indicates if users will be required to pass when requesting access
See:
Number of days after which to delete a user Apono created if no grant is active See:
Resources within the bundle See:
for the integration