Event Types

List of all event types that Emailit can fire off and its payloads.

Email Delivery

Email delivery event is fired off when an email is being sent. There are 7 possible statuses.

JSON payload

{
 "webhook_request_id": "1234567890",
 "event_id": "1234567890",
 "type": "email.delivery.sent",
 "object": {
   "email": {
     "id": 3131351548,
     "token": "a654h0s56dh4a06",
     "type": "outgoing",
     "message_id": "<[email protected]>",
     "to": "[email protected]",
     "from": "[email protected]",
     "subject": "Welcome to Emailit",
     "timestamp": "1727431822.8817",
     "spam_status": 0,
     "tag": null
   },
   "status": "sent",
   "details": "...",
   "sent_with_ssl": true,
   "timestamp": 1727431826.041502,
   "time": 0.56
 }
}

Name
email.delivery.sent
Description
Email has been sent to the recipient.
Name
email.delivery.hardfail
Description
Email could not be delivered to the recipient.
Name
email.delivery.softfail
Description
Email could not be temporarily delivered and will be retried later.
Name
email.delivery.bounce
Description
Email could not be delivered.
Name
email.delivery.error
Description
System error has occured while trying to send this email. Will retry later.
Name
email.delivery.held
Description
Email has been held, your account could be blocked, limited or under review.
Name
email.delivery.delayed
Description
Email has been delayed, likely due to your rate limit.

Email Opens

Email load event is fired off when an email is being loaded.

JSON payload

{
 "webhook_request_id": "1234567890",
 "event_id": "1234567890",
 "type": "email.loaded",
 "object": {
   "email": {
     "id": 3131351548,
     "token": "a654h0s56dh4a06",
     "type": "outgoing",
     "message_id": "<[email protected]>",
     "to": "[email protected]",
     "from": "[email protected]",
     "subject": "Welcome to Emailit",
     "timestamp": "1727431822.8817",
     "spam_status": 0,
     "tag": null
   },
   "ip_address": "127.0.0.1",
   "country": "...",
   "city": "...",
   "user_agent": "...",
   "timestamp": 1727431826.041502
 }
}

Name
email.loaded
Description
Email has been loaded.

Email Link Clicks

Email link click event is fired off when an email link is clicked.

JSON payload

{
 "webhook_request_id": "1234567890",
 "event_id": "1234567890",
 "type": "email.link.clicked",
 "object": {
   "email": {
     "id": 3131351548,
     "token": "a654h0s56dh4a06",
     "type": "outgoing",
     "message_id": "<[email protected]>",
     "to": "[email protected]",
     "from": "[email protected]",
     "subject": "Welcome to Emailit",
     "timestamp": "1727431822.8817",
     "spam_status": 0,
     "tag": null
   },
   "link": {
     "id": 1234567890,
     "url": "https://emailit.dev",
   },
   "ip_address": "127.0.0.1",
   "country": "...",
   "city": "...",
   "user_agent": "...",
   "timestamp": 1727431826.041502
 }
}

Name
email.link.clicked
Description
Email link has been clicked.