Alerts
Elements that can be shared among more than one endpoint definition.
Create a new Alert
POST /v3/alerts
Base url: https://api.sendgrid.com
This endpoint allows you to create a new alert.
Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. There are two types of alerts that can be created with this endpoint:
usage_limitallows you to set the threshold at which an alert will be sent.stats_notificationallows you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly".
For more information about alerts, please see our Alerts documentation.
Authentication
- API Key
Headers
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
The type of alert you want to create. Can be either usage_limit or stats_notification. Example: usage_limit
Allowed Values: stats_notification, usage_limitThe email address the alert will be sent to. Example: test@example.com
format: emailRequired for stats_notification. How frequently the alert will be sent. Example: daily
Required for usage_alert. When this usage threshold is reached, the alert will be sent. Example: 90
{
"type": "stats_notification",
"email_to": "example@example.com",
"frequency": "daily"
}Responses
A Unix timestamp indicating when the alert was created.
The email address that the alert will be sent to.
format: emailIf 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.
Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
