docs- email notifs

This commit is contained in:
Ishaan Jaff 2024-05-25 18:07:36 -07:00
parent ec2e846878
commit 963ca495a2
3 changed files with 52 additions and 1 deletions

View file

@ -0,0 +1,50 @@
import Image from '@theme/IdealImage';
# ✨ 📧 Email Notifications
:::info
This is an Enterprise only feature [Get in touch with us for a Free Trial](https://calendly.com/d/4mp-gd3-k5k/litellm-1-1-onboarding-chat)
:::
Send an Email to your users when:
- A Proxy API Key is created for them
- Their API Key crosses it's Budget
<Image img={require('../../img/email_notifs.png')} style={{ width: '500px' }}/>
## Quick Start
Get SMTP credentials to set this up
Add the following to your proxy env
```shell
SMTP_HOST="smtp.resend.com"
SMTP_USERNAME="resend"
SMTP_PASSWORD="*******"
SMTP_SENDER_EMAIL="support@alerts.litellm.ai" # email to send alerts from: `support@alerts.litellm.ai`
```
Add `email` to your proxy config.yaml under `general_settings`
```yaml
general_settings:
master_key: sk-1234
alerting: ["email"]
```
That's it ! start your proxy
## Customizing Email Branding
LiteLLM allows you to customize the:
- Logo on the Email
- Email support contact
Set the following in your env to customize your emails
```shell
EMAIL_LOGO_URL="https://litellm-listing.s3.amazonaws.com/litellm_logo.png" # public url to your logo
EMAIL_SUPPORT_CONTACT="support@berri.ai" # Your company support email
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

View file

@ -51,9 +51,10 @@ const sidebars = {
label: "Logging",
items: ["proxy/logging", "proxy/streaming_logging"],
},
"proxy/ui",
"proxy/email",
"proxy/team_based_routing",
"proxy/customer_routing",
"proxy/ui",
"proxy/token_auth",
{
type: "category",