Notifications

About Notifications

Chef Automate notifications uses webhooks to send alerts on Chef client run and InSpec compliance scan failures. You can send notifications to Slack channels, Slack users, or any other service that supports webhook integrations.

By default only Admins of Chef Automate may create and manage notifications.

Notifications sent by Chef Automate do not support retries; therefore, notifications sent while Slack or the external service receiving the notification is experiencing API issues, outages, or some other unplanned downtime may never be received. Undelivered notifications are not re-sent. Attempts to send notifications do generate log messages in your Chef Automate server.

Slack Notifications

Add a Slack Notification

To add a Slack notification for Chef Automate:

Node Lifecycle

  1. In the Settings tab, navigate to the Notifications page in the sidebar.
  2. Select Create Notification.
  3. Select Slack.
  4. Enter a unique notification name.
  5. Select the failure type to be notified on from the drop-down menu. Current options are chef client run or InSpec scan
  6. Get your Slack webhook address by using the What’s this? link, which opens an external Slack site.
  7. On the Slack page, select a channel or user for the notification. Slack will create the new webhook and then provide a webhook URL for you to copy. After entering a recipient, use the Add Incoming WebHooks Integration button.
  8. Copy the URL, return to the Chef Automate page, paste the URL into the Notifications form.
  9. Use the Send a test button to try out your Slack notification. If your Slack notification does not appear, return to the Slack Webhooks Integration page to re-check the recipient and URL.
  10. Use the Save Notification button to create the Slack notification.

Edit Slack Notifications

To edit a Slack notification for Chef Automate:

  1. From the Notifications page, select the notification name to open its detail page.
  2. Edit the notification type, name, failure type, or URL.
  3. Use the Save Notification button to save the Slack notification.

Delete Slack Notifications

To delete a Slack notification for Chef Automate:

  1. From the Notifications page, select Delete from the menu at the end of the table row.
  2. Confirm that you wish to permanently delete this notification.

Webhook Notifications

Add a Webhook Notification

To add a webhook notification for Chef Automate:

Node Lifecycle

  1. In the Settings tab navigate to the Notifications page in the sidebar.
  2. Select Create Notification.
  3. Select webhooks.
  4. Enter a unique notification name.
  5. Select the failure type to be notified on from the drop-down menu. Current options are chef client run or InSpec scan
  6. Enter the webhook URL the notification should be sent to.
  7. Use the Send Test button to try out your webhook notification.
  8. Use the Save Notification button to create the webhook notification.

Edit Webhook Notifications

To edit a webhook notification for Chef Automate:

  1. From the Notifications page, select the notification name to open its detail page.
  2. Edit the notification type, name, failure type, or URL.
  3. Use the Save Notification button to save the webhook notification.

Delete Webhook Notifications

To delete a webhook notification for Chef Automate:

  1. From the Notifications page, select Delete from the menu at the end of the table row.
  2. Confirm that you wish to permanently delete this notification in the helper screen.