This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/docs/events/transports.md

37 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

---
title: Transports
---
2021-01-13 09:28:02 +00:00
Notifications can be sent to users via multiple mediums. By default, the [global email configuration](../installation/docker-compose#email-configuration-optional-but-recommended) will be used.
## Generic Webhook
This will send a POST request to the given URL with the following contents:
```json
{
"body": "body of the notification message",
"severity": "severity level as configured in the trigger",
// User that the notification was created for, i.e. a member of the group selected in the rule
"user_email": "notification user's email",
"user_username": "notification user's username",
// User that created the event
"event_user_email": "event user's email",
"event_user_username": "event user's username"
}
```
2021-01-13 09:28:02 +00:00
The `Content-Type` header is set to `text/json`.
Starting in 2021.9, you can also select a Notification mapping. This allows you to freely configure the request's payload. For example:
```python
return {
"foo": context['notification'].body,
}
```
## Slack Webhook
2021-01-13 09:28:02 +00:00
This sends a request using the Slack-specific format. This is also compatible with Discord's webhooks by appending `/slack` to the Discord webhook URL.