# Create a new Alert

## API Overview

Twilio SendGrid's Alerts feature allows you to receive notifications regarding your usage or program statistics from SendGrid at an email address you specify.

### Email credit usage

Usage alerts allow you to set a threshold, when you've used 90% of your email credits, for example, at which point an alert will be sent to your email.

### Statistics summary

Statistics notifications, including email statistics, bounces, spam reports, and category statistics, can be delivered to your email address at one of three frequencies: **Daily**, **Weekly**, or **Monthly**.

See the [**Statistics Overview**](/docs/sendgrid/ui/analytics-and-reporting/stats-overview) for more information about the various statistics SendGrid provides about your email.

## Operation overview

```json
{"path":"https://api.sendgrid.com/v3/alerts","method":"post","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]}
```

**This endpoint allows you to create a new alert.**

## Operation details

### Authentication

API Key

### Headers

```json
[{"in":"header","name":"Authorization","required":true,"default":"Bearer <<YOUR_API_KEY_HERE>>","schema":{"type":"string"}},{"name":"on-behalf-of","in":"header","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id <account-id>`). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: <subuser-username>`). See [**On Behalf Of**](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/OnBehalfOf","modelName":"__components_parameters_OnBehalfOf"}]
```

### Request body

```json
{"schema":{"type":"object","required":["type","email_to"],"example":{"type":"stats_notification","email_to":"example@example.com","frequency":"daily"},"properties":{"type":{"type":"string","description":"The type of alert you want to create. Can be either usage_limit or stats_notification.\nExample: usage_limit","enum":["stats_notification","usage_limit"],"refName":"Type","modelName":"Type"},"email_to":{"type":"string","description":"The email address the alert will be sent to.\nExample: test@example.com","format":"email","nullable":true},"frequency":{"type":"string","description":"Required for stats_notification. How frequently the alert will be sent.\nExample: daily"},"percentage":{"type":"integer","description":"Required for usage_limit. When this usage threshold is reached, the alert will be sent.\nExample: 90"}}},"encodingType":"application/json"}
```

### Responses

```json
[{"responseCode":"201","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","required":["created_at","email_to","id","type","updated_at"],"properties":{"created_at":{"type":"integer","description":"A Unix timestamp indicating when the alert was created."},"email_to":{"type":"string","description":"The email address that the alert will be sent to.","format":"email"},"frequency":{"type":"string","description":"If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent. For example, \"daily\", \"weekly\", or \"monthly\"."},"id":{"type":"integer","description":"The ID of the alert."},"type":{"type":"string","description":"The type of alert."},"updated_at":{"type":"integer","description":"A Unix timestamp indicating when the alert was last modified."},"percentage":{"type":"integer","description":"If the alert is of type `usage_limit`, this indicates the percentage of email usage that must be reached before the alert will be sent."}}},"examples":{"response":{"value":{"created_at":1451520930,"email_to":"test@example.com","frequency":"daily","id":48,"type":"stats_notification","updated_at":1451520930}}}}}}},{"responseCode":"400","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}}}}]
```

Create a new Alert

```js
const client = require("@sendgrid/client");
client.setApiKey(process.env.SENDGRID_API_KEY);

const data = {
  type: "stats_notification",
  email_to: "example@example.com",
  frequency: "daily",
};

const request = {
  url: `/v3/alerts`,
  method: "POST",
  body: data,
};

client
  .request(request)
  .then(([response, body]) => {
    console.log(response.statusCode);
    console.log(response.body);
  })
  .catch((error) => {
    console.error(error);
  });
```

```python
import os
from sendgrid import SendGridAPIClient


sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY"))

data = {
    "type": "stats_notification",
    "email_to": "example@example.com",
    "frequency": "daily",
}

response = sg.client.alerts.post(request_body=data)

print(response.status_code)
print(response.body)
print(response.headers)
```

```csharp
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SendGrid;

public class Program {
    public static async Task Main() {
        string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
        var client = new SendGridClient(apiKey);

        var data =
            @"{
            ""type"": ""stats_notification"",
            ""email_to"": ""example@example.com"",
            ""frequency"": ""daily""
        }";

        var response = await client.RequestAsync(
            method: SendGridClient.Method.POST, urlPath: "alerts", requestBody: data);

        Console.WriteLine(response.StatusCode);
        Console.WriteLine(response.Body.ReadAsStringAsync().Result);
        Console.WriteLine(response.Headers.ToString());
    }
}
```

```java
import com.sendgrid.*;
import java.io.IOException;
import org.json.JSONObject;
import java.util.HashMap;
import java.util.Arrays;

public class Example {
    public static void main(String[] args) throws IOException {
        try {
            SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY"));
            Request request = new Request();
            request.setMethod(Method.POST);
            request.setEndpoint("/alerts");
            request.setBody(new JSONObject(new HashMap<String, Object>() {
                {
                    put("type", "stats_notification");
                    put("email_to", "example@example.com");
                    put("frequency", "daily");
                }
            }).toString());
            Response response = sg.api(request);
            System.out.println(response.getStatusCode());
            System.out.println(response.getBody());
            System.out.println(response.getHeaders());
        } catch (IOException ex) {
            throw ex;
        }
    }
}
```

```go
package main

import (
	"fmt"
	"github.com/sendgrid/sendgrid-go"
	"os"
)

func main() {
	apiKey := os.Getenv("SENDGRID_API_KEY")
	host := "https://api.sendgrid.com"
	request := sendgrid.GetRequest(apiKey, "/v3/alerts", host)
	request.Method = "POST"
	request.Body = []byte(`{
  "type": "stats_notification",
  "email_to": "example@example.com",
  "frequency": "daily"
}`)
	response, err := sendgrid.API(request)
	if err != nil {
		fmt.Println(err.Error())
		os.Exit(1)
	} else {
		fmt.Println(response.StatusCode)
		fmt.Println(response.Body)
		fmt.Println(response.Headers)
	}
}
```

```php
<?php
// Uncomment the next line if you're using a dependency loader (such as Composer) (recommended)
// require 'vendor/autoload.php';

// Uncomment next line if you're not using a dependency loader (such as Composer)
// require_once '<PATH TO>/sendgrid-php.php';

$apiKey = getenv("SENDGRID_API_KEY");
$sg = new \SendGrid($apiKey);
$request_body = json_decode('{
    "type": "stats_notification",
    "email_to": "example@example.com",
    "frequency": "daily"
}');

try {
    $response = $sg->client->alerts()->post($request_body);
    print $response->statusCode() . "\n";
    print_r($response->headers());
    print $response->body() . "\n";
} catch (Exception $ex) {
    echo "Caught exception: " . $ex->getMessage();
}
```

```ruby
require 'sendgrid-ruby'
include SendGrid

sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
data = JSON.parse('{
  "type": "stats_notification",
  "email_to": "example@example.com",
  "frequency": "daily"
}')

response = sg.client.alerts.post(request_body: data)
puts response.status_code
puts response.headers
puts response.body
```

```bash
curl -X POST "https://api.sendgrid.com/v3/alerts" \
--header "Authorization: Bearer $SENDGRID_API_KEY" \
--header "Content-Type: application/json" \
--data '{"type": "stats_notification", "email_to": "example@example.com", "frequency": "daily"}'
```