Subscribing to webhooks

Overview

Frontegg allows developers to subscribe to webhooks in order to trigger automation workflows based on actions that occur on the Frontegg servers.

Examples use cases include:

• Register user on internal DB when the user is invited
• Send marketing email to the user upon first login
• Generate specific transactional flows based on login actions

Read below to learn how to subscribe to webhooks.

Step-By-Step Guide

Follow the steps below to subscribe to webhook events.

STEP 1: Create a new webhook connection

In your Frontegg Portal, go to Environments ➜ [NAME OF ENVIRONMENT] ➜ Integrations.

📘

For instance, go to the development environment at Environments ➜ Development ➜ Integrations.

The page lists all your webhooks and has a button for adding a new webhook.

Click on the Connect button next to Webhooks, fill the webhook details for display name choose the events you want to subscribe to.

STEP 2: Enter URL Address

Enter the URL at which you will receive the webhook data. The URL acts like an address that Frontegg can send a JSON message to when the assigned events happen.

Here is an example of the structure and content of the JSON.

{
  "user": {
    "id": "35639902-a53d-44c3-9aea-066b06569f78",
    "email": "[email protected]",
    "verified": null,
    "name": "cheli",
    "phoneNumber": null,
    "profilePictureUrl": "https://www.gravatar.com/avatar/7827edbdf8ec0d52e57a736448e873c3?d=https://ui-avatars.com/api/eldad/128/random",
    "provider": "local",
    "mfaEnrolled": false,
    "metadata": "{}",
    "tenantIds": [
      "adf4c0a5-9a5e-4c51-a228-d008050c0e15"
    ],
    "tenantId": "adf4c0a5-9a5e-4c51-a228-d008050c0e15",
    "roles": [],
    "permissions": [],
    "createdAt": "2021-05-02T11:25:22.000Z",
    "lastLogin": null,
    "isLocked": false,
    "activatedForTenant": true
  },
  "eventContext": {
    "tenantId": "adf4c0a5-9a5e-4c51-a228-d008050c0e15"
    "userId": "35639902-a53d-44c3-9aea-066b06569f78" //note: userID is optional
    
  },
  "eventKey": "frontegg.user.created"
}

STEP 3: Test

To pass the test, make sure your URL endpoint is up and running and will return a 200 response to the webhook request.

📘

Webhook response

Any 2XX code will be registered as success
Any 4XX code will be registered as failure
The response body can remain empty.

And you are DONE

Security

Protecting your requests with a Secret Key:

You can set a Secret Key for each webhook connection your create.
Just go to Settings Tab , under Secret key Enter a value that is confidential. Frontegg will generate a header called x-webhook-secret and sign the webhook request using the secret.
For enhanced security, Frontegg recommends that you use the webhook secret.

In order to verify the hook's signature using x-webhook-secret header, you should use a method from your backend library.

For example, for Node.js you could use the below function:

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

📘

Frontegg webhooks are sent from below IPs

99.81.198.187
54.216.181.43
52.209.54.22

Webhook events

Read below to learn more about the available events in Frontegg.

Authentication Events

MFA Events

User Management Events

Tenant Events

Custom Webhooks

In addition to webhooks, we also offer custom webhooks, which provide a more flexible and powerful way to create integrations with other 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 custom webhooks