Skip to content

Commit 6f105f9

Browse files
committed
add messageloaded webhook event details
closes postal/postal#629
1 parent c340638 commit 6f105f9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

content/4.developer/4.webhooks.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,29 @@ If you have click tracking enabled, the `MessageLinkClicked` event will tell you
9898
}
9999
```
100100

101+
## Message Loaded/Opened Event
102+
103+
If you have open tracking enabled, the `MessageLoaded` event will tell you that a user has opened your e-mail (or, at least, have viewed the tracking pixel embedded within it.)
104+
105+
```javascript
106+
{
107+
"ip_address":"185.22.208.2",
108+
"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36",
109+
"message":{
110+
"id":12345,
111+
"token":"abcdef123",
112+
"direction":"outgoing",
113+
"message_id":"[email protected]",
114+
115+
116+
"subject":"Welcome to AwesomeApp",
117+
"timestamp":1477945177.12994,
118+
"spam_status":"NotSpam",
119+
"tag":"welcome"
120+
}
121+
}
122+
```
123+
101124
## DNS Error Event
102125

103126
Postal regularly monitors domains it knows about to ensure that your SPF/DKIM/MX records are correct. If you'd like to be notified when the checks fail, you can subscribe to the `DomainDNSError` event.

0 commit comments

Comments
 (0)