Twilio SendGrid's Alerts feature allows you to receive notifications regarding your usage or program statistics from SendGrid at an email address you specify.
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.
This endpoint allows you to create a new alert.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
application/jsonThe type of alert you want to create. Can be either usage_limit or stats_notification. Example: usage_limit
stats_notificationusage_limitThe email address the alert will be sent to. Example: test@example.com
Optional
Required for stats_notification. How frequently the alert will be sent. Example: daily
Optional
Required for usage_limit. When this usage threshold is reached, the alert will be sent. Example: 90
A Unix timestamp indicating when the alert was created.
The email address that the alert will be sent to.
If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent. For example, "daily", "weekly", or "monthly".
The ID of the alert.
The type of alert.
A Unix timestamp indicating when the alert was last modified.
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.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5type: "stats_notification",6email_to: "example@example.com",7frequency: "daily",8};910const request = {11url: `/v3/alerts`,12method: "POST",13body: data,14};1516client17.request(request)18.then(([response, body]) => {19console.log(response.statusCode);20console.log(response.body);21})22.catch((error) => {23console.error(error);24});