On this page

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 for more information about the various statistics SendGrid provides about your email.

Operation overview

POST/v3/alerts

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to create a new alert.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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 for more information.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

typeenum<string>required

The type of alert you want to create. Can be either usage_limit or stats_notification. Example: usage_limit

Possible values:

stats_notificationusage_limit

email_tostring<email> or nullrequired

The email address the alert will be sent to. Example: test@example.com

frequencystringOptional

Required for stats_notification. How frequently the alert will be sent. Example: daily

percentageintegerOptional

Required for usage_limit. When this usage threshold is reached, the alert will be sent. Example: 90

Responses

201400

SchemaExample

Property nameTypeRequiredDescriptionChild properties

created_atinteger

A Unix timestamp indicating when the alert was created.

email_tostring<email>

The email address that the alert will be sent to.

frequencystring

If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent. For example, "daily", "weekly", or "monthly".

idinteger

The ID of the alert.

typestring

The type of alert.

updated_atinteger

A Unix timestamp indicating when the alert was last modified.

percentageinteger

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.

Create a new Alert

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  type: "stats_notification",
6  email_to: "example@example.com",
7  frequency: "daily",
8};
9
10const request = {
11  url: `/v3/alerts`,
12  method: "POST",
13  body: data,
14};
15
16client
17  .request(request)
18  .then(([response, body]) => {
19    console.log(response.statusCode);
20    console.log(response.body);
21  })
22  .catch((error) => {
23    console.error(error);
24  });