The following documentation is applicable to Free, Developer, and Developer Pro plans. For documentation related to the enterprise plan, please click here.

Webhooks API

Refer this document to get API Key and Secret.

Webhook Subscribe

Configures a webhook on your LoginRadius app.

Endpoint

POST https://api.loginradius.com/api/v2/webhook

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
EventAllowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, CreateCustomObject, UpdateCustomobject, DeleteCustomObject
TargetUrlURL where trigger will send data when it invokeModel Class containing Definition of payload for Webhook Subscribe API [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Webhook Subscribed URLs

Fetches all subscribed URLs for a particular event.

Endpoint

GET https://api.loginradius.com/api/v2/webhook

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
eventnoneAllowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, CreateCustomObject, UpdateCustomobject, DeleteCustomObject [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Webhook Test

Tests a subscribed webhook.

Endpoint

GET https://api.loginradius.com/api/v2/webhook/test

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Webhook Unsubscribe

Unsubscribes a webhook configured on your LoginRadius app.

Endpoint

DELETE https://api.loginradius.com/api/v2/webhook

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
EventAllowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, CreateCustomObject, UpdateCustomobject, DeleteCustomObject
TargetUrlURL where trigger will send data when it invokeModel Class containing Definition of payload for Webhook Subscribe API [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Go Back to Home Page


Was this article helpful?

Have more questions? Submit a request