A webhook is an HTTP-based user-defined callback API. Crux allows your applications to receive real-time notifications about the health and quality of your data by sending HTTP requests to a specified URL when an event occurs. You must configure the webhook using a well-known and accessible HTTPS-secured endpoint. Follow the steps below to configure Webhooks for receiving Crux notifications.

You can configure as many Webhooks channels as you would like. When you add multiple Webhooks channels to a Notification Rule, you will receive multiple notifications, one per each Webhook specified in the rule.

Create a Webhook Distribution Channel

To create a Webhook distribution channel, complete these steps:

Go to the Channels menu of your account ⚙️ Settings.
Select Webhooks.
Click on the Add new Webhook channel button.
Give your channel a unique Channel display name so you can later easily locate it.
Provide the Webhook URL, which is the URL of your Webhook POST endpoint. To assure notification delivery, ensure the URL is properly formatted and matches your cloud account.
Provide the Secret parameter in plain text.
Click on the Add Webhook button on the dialog to save the new Webhook distribution channel.

Edit a Webhook Distribution Channel

To edit a Webhook distribution channel, complete these steps:

Go to the Channels menu of your account ⚙️ Settings.
Select Webhooks.
Locate the Webhook distribution channel you would like to modify.
Click on the ... menu located at the end of the distribution channel row, and click on the ✏️ Edit option.
Make changes. You have the flexibility to change the following:
- Channel display name
- Webhook URL
- Secret parameter
Click the Update button on the dialog to save your changes.

Enable and Disable a Webhook Distribution Channel

To enable or disable a Webhook distribution channel, complete these steps:

Go to the Channels menu of your account ⚙️ Settings.
Select Webhooks.
Locate the Webhook distribution channel you would like to enable or disable.
Modify the on/off toggle located next to the Webhook distribution channel.

Delete a Webhook Distribution Channel

To delete a Webhook distribution channel, complete these steps:

Go to the Channels menu of your account ⚙️ Settings.
Select Webhooks.
Locate the Webhook distribution channel you would like to delete.
Click on the ... menu located at the end of the distribution channel row, and click on the Delete option. This action cannot be undone.

Troubleshooting Webhook Distribution Channels

To delete a Webhook distribution channel it should not be in use by any Notification Rules. If you attempt to delete a Webhook distribution channel assigned to one or more Notification Rules, deleting the Webhook channel will fail with the "Channel is currently assigned to one or more rules" error.

You have two alternatives to resolve this issue. Remove all dependencies on this Webhook channel and substitute with alternative distribution channels, or remove the notification rules that depend on it.

Go to the Rules menu, and locate the notification rule(s) that use this Webhook distribution channel. Substitute this Webhook channel with an alternative distribution channel. You can select another Webhook channel or an alternative protocol such as Pub/Sub, SQS, or Email. Alternatively, you can delete all notification rules that use this Webhook channel. After successfully removing notification rules that depend on this Webhook channel, you will be able to delete it.

Closing Thoughts

You have to have an Editor or an Admin role to configure Webhook Distribution Channels for data products in your organization.