Request management event payload

Edit online

You can use the following request management event payloads to trigger asynchronous workflows and synchronizations for event notification webhooks and APIs.

The following table lists the attributes that are contained in access request event.

Table 1. Access request attributes
Name	Data type	Description
data.action	String	The action performed by a user for the resource.
data.approver	String	Specifies the approver who has taken action on the assigned request.
data.approver_comment	String	Specifies the approver comment.
data.approvers	Array List	Specifies the list of approvers that can take action on the assigned request.
data.beneficiary	String	Specifies the beneficiary for the request.
data.cause	String	Specifies the error message.
data.creationDate	String	Specifies time when request is created.
data.current_step	String	Specifies the current step name in a multi-step flow.
data.entitlement_name	String	Specifies the name of the entitlement.
data.entitlement_rights	List<String>	Specifies the rights of the entitlement.
data.entitlement_type	String	Specifies the type of the entitlement.
data.justification	String	Specifies justification for the request.
data.performedby	String	The user ID that performed the action on the instance.
data.reference	String	Specifies the reference of the request. Reference is the same across all requests, when multiple entitlements are requested together.
data.request	String	Specifies Unique identifier (RequestId) of the request.
data.request_number	String	Specifies the request number to track the request.
data.requestor	String	Specifies the ID of the requester.
data.resource	String	Type of a flow. For example, grant-entitlement.
data.status	String	Specifies the status of the request.
data.workflow	String	Specifies the workflow associated with the request.
data.workflow_configuration	List<String>	Specifies the configuration of the workflow associated with the request.

Example

The following code is a sample payload. Use the Events APIs to get the actual attributes. See https://docs.verify.ibm.com/verify/reference/getallevents and https://docs.verify.ibm.com/verify/docs/pulling-event-data.

{"data": {
    "action": "APPROVE",
    "approver": "jane.doe",
    "approver_comment": "Request approved due to valid justification.",
    "approvers": ["jane.doe", "john.smith"],
    "beneficiary": "alice.johnson",
    "cause": "N/A",
    "creationDate": "2025-05-20T14:30:00Z",
    "current_step": "ManagerApproval",
    "entitlement_name": "Admin Access",
    "entitlement_rights": ["READ", "WRITE", "EXECUTE"],
    "entitlement_type": "Role-Based Access",
    "justification": "Required access to manage system configurations.",
    "performedby": "jane.doe",
    "reference": "REF-20250520-1234",
    "request": "REQ-0001234567",
    "request_number": "AR-20250520-7890",
    "requestor": "bob.martin",
    "resource": "grant-entitlement",
    "status": "APPROVED",
    "workflow": "WF-AccessApproval-01",
    "workflow_configuration": ["Step1:Submit", "Step2:ManagerApproval", "Step3:FinalApproval"]
}