How do I configure webhooks to notify user sign up and application requests to an external approval system?
Webhooks can be used to send the user sign up requests or new application registration requests to an external approval systems.
This use case starts when you want to configure an external approval onboarding strategy and ends when you have completed the configuration.
To configure webhooks1. Click the menu options icon
from the title bar and click
Administration.
2. Click Webhooks from the left pane.
3. Provide the external approval system endpoint URL in the field.
4. Select System from the Type list.
5. Provide the required Security preference. Available options are:
Basic. Indicates the basic credentials are required. Provide your user name and password.
None. Indicates that no authentication is required.
6. Select EXTERNAL_VERIFICATION from the Event type list.
7. Click Save.
Your changes are saved.
The webhook is added. Notifications for the selected events are triggered and sent to the specified endpoint.
Next steps:
When there is a user sign up request or an application request, an notification is sent to the configured URL with a payload.
{
"created": "2021-09-03T04:44+0000",
"documentType": "EVENTS",
"parameters": {
"details": {
"email": "u1@sag.com"
},
"source": "ExternalVerificationExecutor",
"link_id": "link_id" },
"type": "EXTERNAL_VERIFICATION_EVENT"
}
The external system processes the new user or application request, and approves or reject the request. The external system must specify the
link_id value received through the payload and approve or reject the requests using the following REST resources:
PUT /rest/v1/approvals/request/external/{id}/approve. Approves the specified external approval request.
PUT /rest/v1/approvals/request/external/{id}/reject. Rejects the specified external approval request.