Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Create a new Alert



API Overview

api-overview page anchor

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

email-credit-usage page anchor

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 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.


POST/v3/alerts

Base url: https://api.sendgrid.com

This endpoint allows you to create a new alert.


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.

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_alert. When this usage threshold is reached, the alert will be sent. Example: 90

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

create-a-new-alert page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_23
const client = require('@sendgrid/client');
_23
client.setApiKey(process.env.SENDGRID_API_KEY);
_23
_23
const data = {
_23
"type": "stats_notification",
_23
"email_to": "example@example.com",
_23
"frequency": "daily"
_23
};
_23
_23
const request = {
_23
url: `/v3/alerts`,
_23
method: 'POST',
_23
body: data
_23
}
_23
_23
client.request(request)
_23
.then(([response, body]) => {
_23
console.log(response.statusCode);
_23
console.log(response.body);
_23
})
_23
.catch(error => {
_23
console.error(error);
_23
});


Rate this page: