What are webhooks?

Frontegg webhooks enable you to automate workflows by triggering specific actions when events occur in Frontegg's servers. This powerful feature allows seamless integration with your existing systems and enhances your application's responsiveness.

Webhook use cases

By leveraging Frontegg webhooks, you can streamline operations, improve user interactions with your app, and control and direct your user's journey in a way that fits your business needs.

Here are some examples of how you can utilize Frontegg webhooks:

• Automating user registration: Automatically register a user in your internal database when they receive an invitation to join your application. This ensures that your records are always up-to-date without the need to manually log in any new user.
• Marketing engagement: Send a personalized marketing email to users immediately after their first login. This can help welcome new users and introduce them to your app's features, thereby improving user engagement and retention.
• Transactional workflow generation: Create complex transactional workflows based on user login activities. For instance, you can trigger security checks, log user activity, or update user status in real time, enhancing both security and user experience.

Configuring webhooks

To create a new webhook connection, head over to your portal, and choose [ENVIRONMENT] ➜ Integrations. The page lists all your webhooks and 3rd party integrations and allows you to create a new one.

Step 1: Create a webhook connection

Click the Connect button next to Webhooks. Fill in the webhook details for the display name and choose the events you want to subscribe to.

Step 2: Enter the URL address

Enter a valid URL to which you will receive the webhook data. The URL acts as an address where Frontegg sends a JSON message when the assigned event occurs. Only once you add a valid address you can test the webhook.

Step 3: Test your webhook request

Press the test button to check that your webhook is working. For the test to succeed, ensure that your URL endpoint is up and running and returns a 200 response to the webhook request.

Set a webhook secret key

We strongly recommend protecting your webhooks by setting a Secret Key for each webhook connection you create.
Go to your webhook's Settings tab and under the Secret key field, enter your desired value. Frontegg will generate a header called x-webhook-secret and will sign the webhook request with that secret value.

To verify the hook's signature using thex-webhook-secret header, you should use a method from your backend library. For Node.js, you could use the following function:

jwt.verify(<x-webhook-secret-value>, <the secret in the dashboard on bhook settings>)

Webhook events

Webhooks in Frontegg cover multiple event types. Here's a list divided by categories:

Authentication events

MFA events

Account management events

User management events

Tenant events

Custom webhooks

Frontegg lets you customize your webhooks, providing a more flexible and powerful way to create integrations with third-party tools. With custom webhooks, you can send data in real time to external applications, allowing you to create customized workflows that cater to your specific needs and automate repetitive tasks. Learn more about creating Custom Webhooks

Configure webhooks in your self-service portal

You need to toggle on that option to enable webhook management for your users in the self-service portal. The toggle is located on the left, as seen in the screenshot below: