events

NotificationRule Viewset

get/events/rules/{pbm_uuid}/

Request

  • Base URL: https://api.goauthentik.io/api/v3
  • URL: https://api.goauthentik.io/api/v3/events/rules/{pbm_uuid}/
  • Auth: HTTP bearer

Path parameters

pbm_uuidstring uuid required

A UUID string identifying this Notification Rule.

Response

pkstring uuid required
namestring required
transportsstring[]

Select which transports should be used to notify the user. If none are selected, the notification will only be shown in the authentik UI.

severity'notice' | 'warning' | 'alert'
destination_groupstring uuid nullable

Define which group of users this notification should be sent and shown to. If left empty, Notification won't ben sent.

destination_event_userboolean

When enabled, notification will be sent to user the user that triggered the event.When destination_group is configured, notification is sent to both.

Changes

No recorded changes to this operation across all 21 revisions of this API.