For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notifications

View and amend notifications for your CIPP App

Configure notifications from CIPP.

CIPP provides alert notifications for Tenants and CIPP actions, sent as one combined table in an email or webhook body.

  • Alert Configuration creates notifications regarding changes within a tenant. See that help page for more information on managing those alerts.

  • CIPP Alerts relate to changes initiated via the CIPP platform.

Available CIPP Alerts

Under the "Choose which logs you would like to receive alerts from" you will be able to select what you would like to receive alerts from CIPP actions. A sample of the alerts is listed below:

  • New Accounts created via CIPP

  • Removed Accounts via CIPP

  • New Applications added via CIPP

  • New Policies added via CIPP

  • New Standards added via CIPP

  • Removed Standards via CIPP

  • Token Refresh Events

Sending Methods

E-mail

Enter as many email addresses as you need, separated by a comma.

Email will be sent from the service account used for the Setup Wizard.

Sent Items Notification emails do not save to the CIPP account's Sent Items folder.

Webhook

Enter a webhook URL. Data is formatted based on the receiving server:

Service
Format

slack.com

A separate markdown-formatted message for each alert.

discord.com

A basic HTML formatted table.

All other services

JSON array of data values. Method is POST

Custom Webhook Formatting: Need something different for your webhook? Can you write PowerShell? Submit a PR on this repo: CIPP-API.

Webhook Authentication

You are optionally able to set authentication on webhooks sent to your automation platform.

Authentication Methods

Method
Description

None

No auth, POST is unauthenticated

Bearer Token

Adds Authorization: Bearer <token> header

Basic Auth

Standard HTTP basic auth

API Key Header

Custom header name + value (e.g. x-api-key: abc123)

Custom Headers (JSON)

Used if the other methods are too restrictive for your needs.

Setting
Description

Webhook Bearer Token

The token value only — CIPP prepends Authorization: Bearer automatically. Masked input.

Webhook Basic Username

Plain text username for HTTP basic auth.

Webhook Basic Password

Password for HTTP basic auth. Masked input.

Webhook API Key Header Name

The header name to use, e.g. x-api-key. Free text — whatever your endpoint expects.

Webhook API Key Header Value

The value for that header. Masked input.

Webhook Custom Headers (JSON)

A full JSON object of key/value header pairs. Must be valid JSON. Example: {"Authorization":"Bearer token","x-api-key":"value"}. Masked input — stored as a secret.

Log and Severity Settings

Log Alerts

Selecting one or more of these log alert types will send an alert to your configured methods if that event occurs in the Logbook.

Alert Severity

Selecting these severities will send any Logbook entry that matches the severity level to your configured methods. See the Logbook Severity chart on the Logbook docs page on the different severities and what they cover.

"Alert" is selected by default. Without this selected any alerts you set up via Alert Configuration will not be sent.

Notification Setting Options

Setting
Description

Receive one email per tenant

Toggling on this option will separate emailed alerts by tenant as opposed to sending all matching log entries as a single alert.

Send notifications to configured integration(s)

This will enable notifications to be sent to the integration(s) you have configured.

Use Standardized Alert Schema

Opts the webhook payload into the versioned schemaVersion: 1.0 envelope. Off by default — existing integrations are unaffected unless this is explicitly enabled.

Standardized Alert Schema

Send Test Alert

You are able to select to send a test alert. Select which options you want to include in your test before clicking Confirm.

Alert Flow Visualized


Feature Requests / Ideas

We value your feedback and ideas. Please raise any feature requests on GitHub.

Last updated

Was this helpful?