Event Types
List of supported event types and their payload.
Delivered
DeliveredOccurs when the email is successfully delivered to the recipients's mail server.
{
"Type": "Delivered",
"CreatedAt": "2025-10-13T05:55:50+00:00",
"MessageId": "cea77391-d390-49e9-9251-75966ace0d4e",
"Data": {
"To": "[email protected]",
"From": "[email protected]",
"Id": "e2689522-8d5d-44d7-bdd2-4110a77a18c4",
"CustomerReference": "123-test"
}
}
Opened
OpenedOccurs when the recipient opened the email.
{
"Type": "Opened",
"CreatedAt": "2025-10-16T23:05:34.9199655+00:00",
"MessageId": "9b83ef3b-1a98-4656-a861-7278db4ac0cf",
"Data": {
"To": "[email protected]",
"From": "[email protected]",
"Id": "e2689522-8d5d-44d7-bdd2-4110a77a18c4",
"CustomerReference": "test-email-001"
}
}
Open tracking needs to be enabled within tracking settings to receive
Openedevents.
Clicked
ClickedOccurs when the recipient clicks on an email link.
{
"Type": "Clicked",
"CreatedAt": "2025-10-16T23:05:34.9199655+00:00",
"MessageId": "9b83ef3b-1a98-4656-a861-7278db4ac0cf",
"Data": {
"To": "[email protected]",
"From": "[email protected]",
"Id": "e2689522-8d5d-44d7-bdd2-4110a77a18c4",
"CustomerReference": "test-email-001"
}
}
Click tracking needs to be enabled within tracking setting to receive
Clickedevents.
Open tracking needs to be enabled within tracking settings.
Bounced
BouncedOccurs when the recipient's mail server permanently rejected the email.
{
"Type": "Bounced",
"CreatedAt": "2025-10-16T11:14:03+00:00",
"MessageId": "2aeee2f3-52cc-4f60-87c0-79e6d075c41d",
"Data": {
"To": "[email protected]",
"From": "[email protected]",
"Id": "e2689522-8d5d-44d7-bdd2-4110a77a18c4",
"CustomerReference": "test-1234",
"Bounce": {
"Type": "HardBounce",
"SubType": "InvalidRecipient",
"Message": "Delivery failed: The recipient's email address is invalid or does not exist. Please verify the address and try again."
}
}
}
Unsubscribed
UnsubscribedOccurs when the recipient unsubscribed by link or header from the email.
{
"Type": "Unsubscribed",
"CreatedAt": "2025-10-16T22:49:50.9076215+00:00",
"MessageId": "2aeee2f3-52cc-4f60-87c0-79e6d075c41d",
"Data": {
"To": "[email protected]",
"From": "[email protected]",
"Id": "e2689522-8d5d-44d7-bdd2-4110a77a18c4",
"CustomerReference": "string",
"Unsubscribe": {
"UnsubscribeType": "UnsubscribedByLink",
"UnsubscribeReason": "test webhook"
}
}
}
Complained
ComplainedOccurs when the email is marked as spam by the recipient.
{
"Type": "Complained",
"CreatedAt": "2025-10-16T23:05:34.9199655+00:00",
"MessageId": "9b83ef3b-1a98-4656-a861-7278db4ac0cf",
"Data": {
"To": "[email protected]",
"From": "[email protected]",
"Id": "e2689522-8d5d-44d7-bdd2-4110a77a18c4",
"CustomerReference": "test-email-001"
}
}
Updated 14 days ago