Webhook Tab

Owned by kapil.katewa (Unlicensed)
Last updated: May 06, 2024
2 min read

Webhook Tab

The Webhooks tab under Settings is where we will manage webhook triggers. Webhooks are event triggers that call 3rd-party web services that subscribe to specific events.

Tenants can create webhooks to trigger calls to subscribing, 3rd-party web services. This is the primary mechanism to initiate identity lifecycle management.

Add Webhook

Follow below steps to add webhooks

  1. Click on the “Add Webhook“ button located on the Webhook tab.

  2. Add Webhook form will be shown.

  3. You are prompt to fill below details on add webhook form-

    1. Name : Would normally be the system that is subscribing to the webhooks

    2. Description : Would be something to remind admin the purpose of the webhook

    3. Enabled : The webhook must be enabled to be triggered

    4. Request Methods :

      • GET

      • POST

    5. Request URL : If the subscribing system listens for all events on a single URL, this is the place to store that URL. All enabled events will result in calling this URL.

    6. Request Headers : If the subscribing system requires headers, those can be configured here. These headers would be used in all webhooks unless overwritten in a specific event webhook.

    7. EVENT SETTINGS :

      • Each event that is expected to trigger a webhook must be enabled

      • If the subscribing system has a specific URL for each event, those individual URL’s would be specified here. If a Webhook URL is defined above Event Triggers, it will be ignored.

      • Headers specific to this event would also be specified here. If Headers are defined above Event Triggers, they will be included but overwritten when names match.

  4. Click “Save“ button or icon to save the webhook.

  5. Webhook card will be created and confirmation message will be shown.

Configure Webhook

Follow below steps to configure webhook

  1. Click anywhere on the webhook card on the Webhook tab to configure

  2. Webhook modification/setting form will be shown.

  3. You can configure the webhook as per your requirements.

  4. Click Save button or Icon to save the changes.

  5. Webhook card will be saved and confirmation message will be shown.



Delete Webhook

  1. On clicking “Delete“ button located on the webhook card a confirmation message will be shown.

  2. Click on the confirm button on the confirmation pop up.

  3. Webhook card will be deleted and confirmation message will be shown.

Module Video Guide -