Enabling OAuth2 Authentication in Webhooks in uKnowva HRMS

Introduction

Webhooks in uKnowva HRMS allow seamless data communication between the system and external platforms by automatically triggering actions when specific events occur.

However, when these connections need to be secured, OAuth2 authentication becomes essential.

OAuth2 is a widely used authorization framework that allows secure access to resources without sharing passwords directly.

It works by issuing access tokens to authorized applications, which are then used to validate requests.

This ensures that only trusted systems can interact with your webhook data, preventing unauthorized access and protecting sensitive information.

Using OAuth2, you can maintain secure integrations while enabling automated workflows between uKnowva HRMS and external applications.

This article explains how you can enable and configure OAuth2 authentication in a webhook within your uKnowva HRMS instance.

Step 1: Accessing the Webhook Configuration

To begin, navigate to the side navigation panel of your uKnowva HRMS instance and click on the Webhook menu.

This will open a new page displaying a list of all existing webhooks configured in your system.

If you want to add OAuth2 authentication to an already existing webhook, simply locate it in the list and click on the pen icon under the Action column to open it in editable mode.

Alternatively, if you wish to create a new webhook, click on the + Add button at the top-right corner of the page.

Step 2: Adding or Editing Webhook Details

Once the webhook page opens, you can either fill in new webhook details or review and update existing ones.

The page will display fields such as Webhook Name, Webhook Description, Webhook Table, Webhook Event, Webhook View Join Conditions, and Webhook URL.

Enter or verify all relevant information to ensure that the webhook triggers correctly and communicates with the target system.

After you’ve reviewed these details, scroll down to the field titled Webhook OAuth2. From the drop-down menu, select Yes to enable OAuth2 authentication for this webhook.

Once selected, additional fields will automatically appear, allowing you to enter OAuth2 configuration details.

Step 3: Configuring OAuth2 Headers and Body

Once OAuth2 is enabled, new input areas for Webhook OAuth2 Header, Webhook OAuth2 URL, and Webhook OAuth2 Body will become visible.

In the Webhook OAuth2 Header section, you can define the authentication headers that the external application requires.

Click on the + button to add a new header row, where you can enter the header details in key-value format. You can also click the – button to remove any unnecessary rows.

Similarly, in the Webhook OAuth2 Body section, you can enter the request body parameters in key-value pairs as required by the OAuth2 token endpoint.

Again, you can use the + and – buttons to add or remove rows based on your configuration needs.

This setup ensures that your webhook can securely obtain and exchange OAuth2 tokens during communication.

Step 4: Completing and Saving the Webhook Configuration

After setting up OAuth2 details, you can further configure other webhook-related settings, such as Webhook Get Parameters, Webhook Header Parameters, and Record Limits to define how many records will be sent per request.

You can also select whether the webhook should be marked as Published or not. You can learn more about webhooks here.

Once you have filled in all required details, click on the Save button to store your configuration.

If you wish to discard your changes, you can click on the Cancel button instead.

Conclusion

That’s it!

You’ve now successfully enabled OAuth2 authentication for a webhook in uKnowva HRMS.

By following this process, you ensure that your webhook integrations are not only functional but also securely authorized through token-based authentication.

This feature adds an additional layer of security and reliability to your system-to-system communication.

If you have any questions or need additional support, feel free to contact us at This email address is being protected from spambots. You need JavaScript enabled to view it..

Was this Article helpful?