Menu

Alerts

Elements that can be shared among more than one endpoint definition.

Retrieve a specific alert

Retrieve a specific alert

GET /alerts/{alert_id}

This endpoint allows you to retrieve a specific alert.

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

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Path Parameters

alert_id
integer

The ID of the alert you would like to retrieve.

required

Responses

object
created_at
integer

A Unix timestamp indicating when the alert was created.

required
email_to
string

The email address that the alert will be sent to.

required
frequency
string

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

id
integer

The ID of the alert.

required
type
string

The type of alert.

Allowed Values: usage_alert, stats_notification
required
updated_at
integer

A Unix timestamp indicating when the alert was last modified.

required
percentage
integer

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; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.