LogoLogo
Documentation and Guides
Documentation and Guides
  • ABOUT APONO
    • Why Choose Apono
    • Security and Architecture
    • Glossary
  • GETTING STARTED
    • How Apono Works
    • Getting started
    • Access Discovery
    • Integrating with Apono
  • CONNECTORS AND SECRETS
    • Apono Integration Secret
    • High Availability for Connectors
    • Installing a connector with Docker
    • Manage integrations
    • Manage connectors
  • AWS ENVIRONMENT
    • AWS Overview
    • Apono Connector for AWS
      • Installing a connector on EKS Using Terraform
      • Updating a connector in AWS
      • Installing a connector on AWS ECS using Terraform
    • AWS Integrations
      • Integrate an AWS account or organization
        • Auto Discover AWS RDS Instances
        • AWS Best Practices
      • Amazon Redshift
      • RDS PostgreSQL
      • AWS RDS MySQL
      • Integrate with EKS
      • AWS Lambda Custom Integration
      • EC2 via Systems Manager Agent (SSM)
  • AZURE ENVIRONMENT
    • Apono Connector for Azure
      • Install an Azure connector on ACI using Azure CLI
      • Install an Azure connector on ACI using PowerShell
      • Install an Azure connector on ACI using Terraform
      • Updating a connector in Azure
    • Azure Integrations
      • Integrate with Azure Management Group or Subscription
        • Auto Discover Azure SQL Databases
      • Azure MySQL
      • Azure PostgreSQL
      • Integrate with AKS
  • GCP ENVIRONMENT
    • Apono Connector for GCP
      • Installing a GCP connector on Cloud Run using CLI
      • Installing a GCP connector on GKE using CLI (Helm)
      • Installing a GCP connector on GKE using Terraform
      • Updating a connector in Google Cloud
    • GCP Integrations
      • Integrate a GCP organization or project
      • CloudSQL - MySQL
      • CloudSQL - PostgreSQL
      • Google Cloud Functions
      • Integrate with GKE
      • AlloyDB
  • KUBERNETES ENVIRONMENT
    • Apono Connector for Kubernetes
      • Installing a connector on Kubernetes with AWS permissions
      • Updating a Kubernetes connector
    • Kubernetes Integrations
      • Integrate with Self-Managed Kubernetes
  • ADDITIONAL INTEGRATIONS
    • Databases and Data Repositories
      • Microsoft SQL Server
      • MongoDB
      • MongoDB Atlas
      • MongoDB Atlas Portal
      • MySQL
      • Oracle Database
      • PostgreSQL
      • Redis Cloud (Redislabs)
      • Snowflake
      • Vertica
      • MariaDB
    • Network Management
      • SSH Servers
      • RDP Servers
      • Windows Domain Controller
      • AWS EC2 SSH Servers
      • Azure VM SSH Servers
      • Installing the Apono HTTP Proxy
    • Development Tools
      • GitHub
      • Rancher
    • Identity Providers
      • Okta SCIM
      • Okta Groups
      • Okta SSO for Apono logins
      • Google Workspace (Gsuite)
      • Google Workspace (GSuite) Groups
      • Azure Active Directory (Microsoft Entra ID)
      • Azure Active Directory (Entra ID) Groups
      • Jumpcloud
      • JumpCloud Groups
      • OneLogin
      • OneLogin Group
      • LDAP Groups
      • The Manager Attribute in Access Flows
      • HiBob
      • Ping Identity SSO
    • Incident Response Integrations
      • Opsgenie
      • PagerDuty
      • VictorOps (Splunk On-Call)
      • Zenduty
    • ChatOps Integrations
      • Slack integration
      • Teams integration
      • Backstage Integration
  • WEBHOOK INTEGRATIONS
    • Webhooks Overview
    • Anomaly Webhook
    • Audit Log Webhook
    • Request Webhook
      • Custom Webhooks
      • Communications and Notifications
        • Slack Outbound Webhooks
        • Teams
        • Outlook and Gmail (Using Azure Logic App)
      • ITSM
        • Freshdesk
        • Jira
        • ServiceNow
        • Zendesk
        • Freshservice
        • ServiceDesk Plus
      • Logs and SIEMs
        • Coralogix
        • Datadog
        • Logz.io
        • Grafana
        • New Relic
        • SolarWinds
        • Sumo Logic
        • Cortex
        • Logpoint
        • Splunk
        • Microsoft Sentinel
      • Orchestration and workflow builders
        • Okta Workflows
        • Torq
    • Integration Webhook
    • Webhook Payload References
      • Audit Log Webhook Payload Schema Reference
      • Webhook Payload Schema Reference
    • Manage webhooks
    • Troubleshoot a webhook
    • Manual Webhook
      • ITSM
        • PagerDuty
  • ACCESS FLOWS
    • Access Flows
      • What are Access Flows?
    • Create Access Flows
      • Self Serve Access Flows
      • Automatic Access Flows
      • Access Duration
    • Manage Access Flows
      • Right Sizing
    • Revoke Access
    • Dynamic Access Management
      • Resource and Integration Owners
    • Common Use Cases
      • Ensuring SLA
      • Protecting PII and Customer Data
      • Production Stability and Management
      • Break Glass Protocol
    • Create Bundles
    • Manage Bundles
  • ACCESS REQUESTS AND APPROVALS
    • Slack
      • Requesting Access with Slack
      • Approving Access with Slack
    • Teams
      • Requesting Access with Teams
      • Approving Access with Teams
    • CLI
      • Install and manage the Apono CLI
      • Requesting Access with CLI
    • Web Portal
      • Requesting Access with the Web Portal
      • Approving Access with the Web Portal
      • Reviewing historical requests with the Web Portal
    • Freshservice
    • Favorites
  • Inventory
    • Inventory Overview
    • Inventory
    • Access Scopes
    • Risk Scores
    • Apono Query Language
  • AUDITS AND REPORTS
    • Activity Overview
      • Activity
      • Create Reports
      • Manage Reports
    • Compliance: Audit and Reporting
    • Auditing Access in Apono
    • Admin Audit Log (Syslog)
  • HELP AND DEBUGGING
    • Integration Status Page
    • Troubleshooting Errors
  • ARCHITECTURE AND SECURITY
    • Anomaly Detection
    • Multi-factor Authentication
    • Credentials Rotation Policy
    • Periodic User Cleanup & Deletion
    • End-user Authentication
    • Personal API Tokens
  • User Administration
    • Role-Based Access Control (RBAC) Reference
    • Create Identities
    • Manage Identities
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. WEBHOOK INTEGRATIONS
  2. Webhook Payload References

Webhook Payload Schema Reference

Send Apono access request data to your internal systems with event-triggered HTTP messages

PreviousAudit Log Webhook Payload Schema ReferenceNextManage webhooks

Last updated 4 months ago

Was this helpful?

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 templating language to format expressions for certain data fields.

{
    "event_type": "AccessRequestCreated",
    "event_time": 1696263265.851898000,
    "data": {
        "id": "123",
        "friendly_id": "AR-123",
        "requester": {
            "id": "user-1",
            "name": "User",
            "email": "user@example.com"
        },
        "justification": "I need access to this",
        "creation_date": 1696263265.852378000,
        "revocation_date": 1696266865.852380000,
        "access_flow": {
            "id": "flow-1",
            "name": "Flow 1"
        },
        "access_bundle": {
            "id": "bundle-1",
            "name": "Bundle 1"
        },
        "access_groups": [
            {
                "integration": {
                    "id": "integration-1",
                    "type": "Postgresql",
                    "name": "prod db"
                },
                "resource_types": [
                    {
                        "id": "postgresql-database",
                        "name": "Database",
                        "display_path": "Postgresql/Database"
                    }
                ],
                "access_units": [
                    {
                        "resource": {
                            "id": "res-1",
                            "name": "DB 1",
                            "path": "prod db/res-1",
                            "type": {
                                "id": "postgresql-database",
                                "name": "Database",
                                "display_path": "Postgresql/Database"
                            }
                        },
                        "permission": {
                            "id": "ReadOnly",
                            "name": "ReadOnly"
                        }
                    },
                    {
                        "resource": {
                            "id": "res-2",
                            "name": "DB 2",
                            "path": "prod db/res-2",
                            "type": {
                                "id": "postgresql-database",
                                "name": "Database",
                                "display_path": "Postgresql/Database"
                            }
                        },
                        "permission": {
                            "id": "ReadOnly",
                            "name": "ReadOnly"
                        }
                    }
                ]
            }
        ],
        "approvals_logical_relation": "AllOf",
        "approvals": [
            {
                "name": "Manager",
                "type": "Manager",
                "status": "Pending"
            },
            {
                "name": "Admins",
                "type": "Group",
                "status": "Approved",
                "approver": {
                    "id": "admin-1",
                    "name": "Admin 1",
                    "email": "admin@example.com"
                }
            }
        ]
    }
}
Property
Description

event_type string

event_time float

Time of the event occurrence in epoch seconds.milliseconds

data object

data object

Property
Description

id string

Apono request ID

friendly_id string

Human-readable ID that also appears in the Apono UI

requester object

justification string

Reason provided by requester for needing access

creation_date float

Date the access request was created in epoch seconds.milliseconds

revocation_date float

access_flow object

access_bundle object

access_groups object

approvals_logical_relation string

Whether the request requires one approver (AnyOf value) or all approvers within a group (AllOf value)

approvals object

\

data.requester object

Property
Description

id string

Requester's Apono ID

name string

Requester’s Apono username

email string

Requester’s email address

\

data.access_flow object

Property
Description

id string

Apono ID for the access flow

name string

Customer-created name for the access flow

\

data.access_bundle object

Property
Description

id string

Apono ID for the access bundle

name string

Customer-created name for the access bundle

\

data.access_groups object

Property
Description

integration object

Metadata about the integration that the requester wants to access See data.access_groups.integration object

resource_types object

Metadata about the resource types that the requester wants to access See data.access_groups.resource_types object

access_units object

Metadata about the requested access unit, which is a pairing of a resource and a permission See data.access_groups.access_units object.

\

data.access_groups.integration object

Property
Description

id string

Apono ID of the integration

type string

Type of resource the requester wants to access, such as Postgresql

name string

Customer-created resource name

\

data.access_groups.resource_types object

Property
Description

id string

Apono ID of the integration

name string

Display name for the resource

display_path string

Logical, hierarchical container for the resource For example, the display path for an AWS bucket resource type might be AWS-account/us-east/bucket/E2

\

data.access_groups.access_units object

Property
Description

resource object

Metadata about the resource the requester wants to access See data.access_groups.access_units.resource object

permissions object

Metadata about resource permission granted to the requester See data.access_groups.access_units.permissions object

\

data.access_groups.access_units.resource object

Property
Description

id string

Apono ID of the resource

name string

Customer-created name for the resource

path string

Physical path of the resource For example, the path of a database would be database-name/table-name

type object

Metadata about the resource type the requester wants to access See data.access_groups.access_units.resource.type object

\

data.access_groups.access_units.resource.type object

Property
Description

id string

Apono ID of the resource type

name string

Name of the resource type

display_path string

Logical, hierarchical container for the resource For example, the display path for an AWS bucket resource type might be AWS-account/us-east/bucket/E2.

\

data.access_groups.access_units.permissions object

Property
Description

id string

Apono ID for the permission

name string

Name of the permission granted to the requester, such as ReadOnly

\

data.approvals object

Property
Description

name string

Name of the entity approving the request, which could be:

  • A person

  • A group, such as an Okta group

  • A work shift

  • The word Manager

type string

Type of approver Possible values:

  • Person

  • Group, such as an Okta group

  • Shift, such as an on-call shift

  • Manager

status string

Status of the request Possible values:

  • Approved

  • Rejected

  • Pending

approver object

Metadata about the person approving the access request See data.approvals.approver object.

\

data.approvals.approver object

Property
Description

id string

Approver's Apono ID

name string

Approver's Apono username

email string

Approver's email address

Webhook trigger, corresponding to different

Field containing an embedded object with contextual information about the triggering event See .

Metadata about the user requesting access See

Date the access request was in epoch seconds.milliseconds

Metadata about a related See data.access_flow object

Metadata about a related See data.access_bundle object

Metadata about related and resources that the requester wants to access See

Metadata about approved access requests See

Handlebars
revoked
access flow
access bundle
data object
data.requester object
integrations
data.access_groups object
data.approvals object
access request statuses