Skip to main content

Notification Rules

info

To prevent notification loops, events created by policies that are attached to any notification rule do not trigger notifications.

An authentik administrator can create notification rules for selected events. The authentik policy engine filters events through a policy that is bound to a notification rule.

Workflow overview​

To receive notifications about events, follow this workflow:

  1. Create a notification transport (or use a default notification transport).
  2. Create a policy.
  3. Create a notification rule and bind the policy to the rule.

1. Create a notification transport​

A notification transport determines how authentik delivers notifications to users. Supported delivery methods are local notifications in the authentik UI, email, and webhook. To create a notification transport, see Create a notification transport.

2. Create a policy​

Create a policy that defines which events trigger a notification. For simple conditions, use an Event Matcher policy. For custom logic, use an Expression policy.

Event Matcher policy​

For simple event matching, create and configure an Event Matcher policy to define which events trigger a notification. Use the policy's AKQL query when you need to match event context fields such as context.geo.country or context.authorized_application.name.

An event must match all configured fields in the policy. Otherwise, the notification rule does not trigger.

Expression policy for events​

To match events with an Expression policy, use code such as the following example:

if "event" not in request.context:
    return False

return ip_address(request.context["event"].client_ip) in ip_network('192.0.2.0/24')

For more code examples, see notification rule expression policies.

3. Create a notification rule and bind it to the policy​

After you create the policies to match the relevant events, create a notification rule.

  1. Log in as an administrator, open the authentik Admin interface, and navigate to Event > Notification Rules.

  2. Click New Notification Rule to add a new notification rule or click the Edit icon next to an existing rule to modify it.

  3. Define the rule configuration, and then click Create Notification Rule or Update to save the settings.

  • Policies are executed regardless of whether a destination is selected. Notifications are only created when a destination group is selected or Send notification to event user is enabled.
  • Select which notification transport authentik uses to send the notification. Two notification transports are created by default:
    • default-email-transport: Delivers notifications via email using the global email configuration.
    • default-local-transport: Delivers notifications within the authentik UI.

  1. In the list of notification rules, click the arrow in the row of the notification rule to expand the details of the rule.

  2. Click Create or bind.... Under Bind Existing..., select Bind an existing policy. In the Create Binding modal, select the policy that you created for this notification rule, and then click Create.