MessageEvents
Last updated
Last updated
Name
Type
Description
MessageId
String
The Id of the message.
EventName
String
Name of event.
The allowed values are bounced, opened, clicked, processed, dropped, delivered, deferred, spam_report, unsubscribe, group_unsubscribe, group_resubscribe.
Processed
Datetime
The date when the event was processed.
Reason
String
Explanation of what caused the message to be 'bounced', 'deferred', or 'blocked'.
AttemptNum
Integer
Used with 'deferred' events to indicate the attempt number out of 10.
Url
String
Used with 'clicked' event to indicate which url the user clicked.
BounceType
String
Use to distinguish between types of bounces.
The allowed values are soft, hard.
HttpUserAgent
String
Client recipient used to click or open message.
MXServer
String
The MX server that received the email.
ApiKeyId
String
Id of the API Key.
AsmGroupId
String
ASM Group Id.
Categories
String
Categories users associated to the message.
UniqueArgs
String
JSON hash of key-value pairs associated with the message.
OriginatingIp
String
This is the IP address of the person sending the message
OutboundIp
String
This is the SendGrid dedicated IP address used to send the email
OutboundIpType
String
The type of the outbound IP.
Teammate
String
Username of the teammate.
TemplateId
String
Template ID of the email.