Webhooks
Webhooks allow you to integrate LoginRadius with external systems by sending real-time HTTP POST requests to specified URLs whenever certain events occur. This mechanism empowers you to build event-driven applications, automate workflows, and ensure synchronized data across platforms. Below are some examples of how these webhooks can help your business use cases.
- Real-Time Event Notifications: Webhooks deliver instant payloads to your endpoint for subscribed events.
- Event Subscription Flexibility: Configure webhooks for specific events to suit your application's needs.
- Secure Integration: Enforce HTTPS with hashed payload signatures for reliable and secure communication.
Webhooks act as a bridge to connect LoginRadius with other systems seamlessly and securely.
Use Cases
Webhooks serve various use cases across different domains. Whether it’s user tracking, workflow automation, or real-time notifications, webhooks can streamline processes and enhance system efficiency.
Popular Scenarios:
- Real-Time Data Sync: Keep external systems updated with user profile changes, such as CRM integrations or analytics dashboards.
- Workflow Automation: Trigger events like email campaigns or inventory updates in response to user activities.
- Behavioral Analytics: Capture and analyze user interactions, such as logins or profile modifications, for business insights.
Webhooks simplify the integration of LoginRadius data into your ecosystem, allowing businesses to stay agile and responsive.
Integration and Configuration
LoginRadius supports two methods for configuring webhooks: through the Admin Console and APIs. This flexibility allows you to implement webhook setups according to their preferences and workflows.
Steps to configure in the Admin Console
- Access Webhooks: Go to Integrations > Webhooks in the Admin Console.
- Create a Webhook:
- Assign a unique webhook name.
- Select an event from the dropdown.
- Provide a Subscribe URL where payloads will be sent.
- Choose an API secret for signature generation.
- Save and Review: The configured webhook appears in the Configured Requests table for editing or unsubscribing.
You can also manage your webhooks by editing, updating, or unsubscribing from events as your needs change.
Key Actions:
- Editing: Modify event subscriptions or associated API secrets directly in the Admin Console.
- Unsubscribing: Remove unwanted event subscriptions to keep your system efficient.
- Custom Objects: Update or manage custom objects via the webhook interface for tailored workflows.
API Integration:
For dynamic setups, use the LoginRadius Webhooks API to manage subscriptions and configurations programmatically. Webhooks provide a developer-friendly approach for real-time and scalable integrations with minimal overhead.
Events
Events are the core triggers that activate webhooks. LoginRadius offers a broad range of events, enabling precise control over what data is shared with your systems.
Supported Events:
- User Authentication: Login, Register, ChangePassword, ResetPassword.
- Profile Management: UpdateProfile, VerifyPhoneNumber, AddEmail, RemoveEmail.
- Account Changes: BlockAccount, DeleteAccount, SetUsername.
- Custom Data: CreateCustomObject, UpdateCustomObject, DeleteCustomObject.
- Security Updates: SetPIN, ResetPIN, ChangePIN.
By subscribing only to necessary events, you can reduce unnecessary API calls and optimize server performance.
Webhook Payloads and Headers
Webhooks deliver structured payloads for each event, ensuring all relevant data is readily available for processing.
Key Components:
- Headers: Include fields like signature, host, content-type, and others for secure identification.
- Payload Body: Varies by event and includes details such as user profiles, timestamps, and field changes.
For instance:
- A Login Event payload contains user details and timestamps.
- A Profile Update Event highlights the fields that were modified.
You can use this data for workflows, backups, or analytics. Here is the sample for the WebHook payload header:
WebHook sample payload Body for these events can be seen by clicking on the link provided for specific events.
| Event | Sample Payload |
|---|---|
| Login | Link |
| Register | Link |
| UpdateProfile | Link |
| ResetPassword | Link |
| ChangePassword | Link |
| emailVerification | Link |
| AddEmail | Link |
| RemoveEmail | Link |
| BlockAccount | Link |
| DeleteAccount | Link |
| SetUsername | Link |
| AssignRoles | Link |
| UnassignRoles | Link |
| SetPassword | Link |
| LinkAccount | Link |
| UnlinkAccount | Link |
| UpdatePhoneId | Link |
| VerifyPhoneNumber | Link |
| UpdateCustomobject | Link |
| DeleteCustomObject | Link |
| CreateCustomObject | Link |
| InvalidateEmailVerification | Link |
| InvalidatePhoneVerification | Link |
| RemovePhoneId | Link |
| RemoveRoleContext | Link |
| SetPin | Link |
| ResetPin | Link |
| ChangePin | Link |
Security
Ensuring webhook payload security is crucial. LoginRadius enforces HTTPS and provides signature verification using your API secret to authenticate data integrity. Implementing signature validation ensures that only authorized payloads are processed. For detailed implementation, refer to the Webhook Security Guide.
The Tenant Management -> Audit section records all changes made to webhooks, including adding new or deleting existing webhooks. For further information, please refer to our Audit Log documentation.