Using Webhooks for Notifications

Facets Control Plane provides the capability to use webhooks for receiving notifications based on various different payloads.

Prerequisites

To set up webhooks for notifications:

  1. A defined Blueprint must exist in your organization's account.
  2. A Channel should exist with type WEBHOOK.

Set up Webhooks for Notifications from your Control Plane

⚠️

You need to have ADMIN role to be able to create and manage Notifications in your organization's account.

  1. Login to your Control Plane.
  2. Click on the Settings icon in your sidebar.
Settings button in sidebar (Click on the image to expand)Settings button in sidebar (Click on the image to expand)

Settings button in sidebar (Click on the image to expand)

  1. Click on Notifications tab.
  2. Click on Create Channel (Go to Step 6 if you already have a channel of type WEBHOOK).
Create Channel (Click on the image to expand)Create Channel (Click on the image to expand)

Create Channel (Click on the image to expand)

  1. Select the Channel Type as WEBHOOK and add appropriate Channel Name and Channel URL.
Webhook Channel Type (Click on the image to expand)Webhook Channel Type (Click on the image to expand)

Webhook Channel Type (Click on the image to expand)

📘

NOTE

The Channel URL should be the URL for the Webhook where you want to receive notifications.

  1. Select Create Subscription if you want to create a new one or Edit Subscription to edit an existing one.
Create or Edit Subscription (Click on the image to expand)Create or Edit Subscription (Click on the image to expand)

Create or Edit Subscription (Click on the image to expand)

  1. Select the Blueprint, the webhook based Channel and set a Notification Type, then click on Add Payload.
Add Payload (Click on the image to expand)Add Payload (Click on the image to expand)

Add Payload (Click on the image to expand)

  1. Add the appropriate details necessary for your webhook notification in the Payload Template, then click on Save Payload.
Save Payload (Click on the image to expand)Save Payload (Click on the image to expand)

Save Payload (Click on the image to expand)

  1. You have successfully added a webhook subscription to receive notifications. Click on Create Subscription to save your subscription.
    NOTE: You can also Edit and View your Payload in this screen.
Create Subscription (Click on the image to expand)Create Subscription (Click on the image to expand)

Create Subscription (Click on the image to expand)

Constraints

A defined blueprint and a channel of type WEBHOOK should exist for you to be able to create a webhook based subscription for notifications.


Did this page help you?