A Webhook for triggering logic upon a user creation within AdminUI. This could be used for finialising account creation, setting up passwords, or sending out communications.
Configuration
To enable the User Registration webhook within AdminUI, you must first have configured a webhook Client for authorization with AdminUI and IdentityServer. For more information see Webhooks
You will then need to create an Endpoint secured and Authenticated by your IdentityServer that uses the admin_ui_webhooks scope for authorization.
Once you have your Endpoint configured, you can set the RegistrationConfirmationEndpoint config setting with the AdminUI API config with Url for your endpoint. If this field is set then on successful User creation this Webhook will be triggered.
Endpoint
AdminUI expects your endpoint to meet the following requirements:
- Accept POST
- Accept JSON
- Accept an email and username in the body
The request made by AdminUI will look like the following:
Headers
Content-Type: application/json
Authorization: Bearer xyz
Body
{
"email": "string",
"username": "string"
}
Response
On a successful Password Reset a 200 OK response should be returned, anything other than a success code will show the User the that reset the password an error message, informing them that the Password Reset was unsucessful.
Debugging
If the call made to the endpoint returns anything other than a success code, if logging is correctly configured, a error will be logged by the API containing the returned status code.