Alerts
Elements that can be shared among more than one endpoint definition.
Retrieve all alerts
GET /v3/alerts
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve all of your alerts.
Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow 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.
Responses
The list of alerts.
A Unix timestamp indicating when the alert was created.
The email address that the alert will be sent to.
The ID of the alert.
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.
The type of alert.
Allowed Values: usage_limit, stats_notificationA Unix timestamp indicating when the alert was last modified.
If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent. For example, "daily", "weekly", or "monthly".
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.
