Skip to content

Commit

Permalink
add messageloaded webhook event details
Browse files Browse the repository at this point in the history
closes postal/postal#629
  • Loading branch information
adamcooke committed Mar 10, 2024
1 parent c340638 commit 6f105f9
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions content/4.developer/4.webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,29 @@ If you have click tracking enabled, the `MessageLinkClicked` event will tell you
}
```

## Message Loaded/Opened Event

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.)

```javascript
{
"ip_address":"185.22.208.2",
"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",
"message":{
"id":12345,
"token":"abcdef123",
"direction":"outgoing",
"message_id":"5817a64332f44_4ec93ff59e79d154565eb@app34.mail",
"to":"test@example.com",
"from":"sales@awesomeapp.com",
"subject":"Welcome to AwesomeApp",
"timestamp":1477945177.12994,
"spam_status":"NotSpam",
"tag":"welcome"
}
}
```

## DNS Error Event

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.
Expand Down

0 comments on commit 6f105f9

Please sign in to comment.