Skip to content

Instantly share code, notes, and snippets.

@ramonsmits
Created November 20, 2013 13:52
Show Gist options
  • Save ramonsmits/7563502 to your computer and use it in GitHub Desktop.
Save ramonsmits/7563502 to your computer and use it in GitHub Desktop.
Example of Mandrill webhook JSON data.
[
{
"event": "send",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"opens": [
],
"clicks": [
],
"state": "sent",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa",
"_version": "exampleaaaaaaaaaaaaaaa"
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa",
"ts": 1384954004
},
{
"event": "deferral",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"opens": [
],
"clicks": [
],
"state": "deferred",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa1",
"_version": "exampleaaaaaaaaaaaaaaa",
"smtp_events": [
{
"destination_ip": "127.0.0.1",
"diag": "451 4.3.5 Temporarily unavailable, try again later.",
"source_ip": "127.0.0.1",
"ts": 1365111111,
"type": "deferred",
"size": 0
}
]
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa1",
"ts": 1384954004
},
{
"event": "hard_bounce",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"state": "bounced",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa2",
"_version": "exampleaaaaaaaaaaaaaaa",
"bounce_description": "bad_mailbox",
"bgtools_code": 10,
"diag": "smtp;550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces."
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa2",
"ts": 1384954004
},
{
"event": "soft_bounce",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"state": "soft-bounced",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa3",
"_version": "exampleaaaaaaaaaaaaaaa",
"bounce_description": "mailbox_full",
"bgtools_code": 22,
"diag": "smtp;552 5.2.2 Over Quota"
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa3",
"ts": 1384954004
},
{
"event": "open",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"opens": [
{
"ts": 1365111111
}
],
"clicks": [
{
"ts": 1365111111,
"url": "http:\/\/mandrill.com"
}
],
"state": "sent",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa4",
"_version": "exampleaaaaaaaaaaaaaaa"
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa4",
"ip": "127.0.0.1",
"location": {
"country_short": "US",
"country": "United States",
"region": "Oklahoma",
"city": "Oklahoma City",
"latitude": 35.4675598145,
"longitude": -97.5164337158,
"postal_code": "73101",
"timezone": "-05:00"
},
"user_agent": "Mozilla\/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.1.8) Gecko\/20100317 Postbox\/1.1.3",
"user_agent_parsed": {
"type": "Email Client",
"ua_family": "Postbox",
"ua_name": "Postbox 1.1.3",
"ua_version": "1.1.3",
"ua_url": "http:\/\/www.postbox-inc.com\/",
"ua_company": "Postbox, Inc.",
"ua_company_url": "http:\/\/www.postbox-inc.com\/",
"ua_icon": "http:\/\/cdn.mandrill.com\/img\/email-client-icons\/postbox.png",
"os_family": "OS X",
"os_name": "OS X 10.6 Snow Leopard",
"os_url": "http:\/\/www.apple.com\/osx\/",
"os_company": "Apple Computer, Inc.",
"os_company_url": "http:\/\/www.apple.com\/",
"os_icon": "http:\/\/cdn.mandrill.com\/img\/email-client-icons\/macosx.png",
"mobile": false
},
"ts": 1384954004
},
{
"event": "click",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"opens": [
{
"ts": 1365111111
}
],
"clicks": [
{
"ts": 1365111111,
"url": "http:\/\/mandrill.com"
}
],
"state": "sent",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa5",
"_version": "exampleaaaaaaaaaaaaaaa"
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa5",
"ip": "127.0.0.1",
"location": {
"country_short": "US",
"country": "United States",
"region": "Oklahoma",
"city": "Oklahoma City",
"latitude": 35.4675598145,
"longitude": -97.5164337158,
"postal_code": "73101",
"timezone": "-05:00"
},
"user_agent": "Mozilla\/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.1.8) Gecko\/20100317 Postbox\/1.1.3",
"user_agent_parsed": {
"type": "Email Client",
"ua_family": "Postbox",
"ua_name": "Postbox 1.1.3",
"ua_version": "1.1.3",
"ua_url": "http:\/\/www.postbox-inc.com\/",
"ua_company": "Postbox, Inc.",
"ua_company_url": "http:\/\/www.postbox-inc.com\/",
"ua_icon": "http:\/\/cdn.mandrill.com\/img\/email-client-icons\/postbox.png",
"os_family": "OS X",
"os_name": "OS X 10.6 Snow Leopard",
"os_url": "http:\/\/www.apple.com\/osx\/",
"os_company": "Apple Computer, Inc.",
"os_company_url": "http:\/\/www.apple.com\/",
"os_icon": "http:\/\/cdn.mandrill.com\/img\/email-client-icons\/macosx.png",
"mobile": false
},
"url": "http:\/\/mandrill.com",
"ts": 1384954004
},
{
"event": "spam",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"opens": [
{
"ts": 1365111111
}
],
"clicks": [
{
"ts": 1365111111,
"url": "http:\/\/mandrill.com"
}
],
"state": "sent",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa6",
"_version": "exampleaaaaaaaaaaaaaaa"
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa6",
"ts": 1384954004
},
{
"event": "unsub",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"opens": [
{
"ts": 1365111111
}
],
"clicks": [
{
"ts": 1365111111,
"url": "http:\/\/mandrill.com"
}
],
"state": "sent",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa7",
"_version": "exampleaaaaaaaaaaaaaaa"
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa7",
"ts": 1384954004
},
{
"event": "reject",
"msg": {
"ts": 1365109999,
"subject": "This an example webhook message",
"email": "[email protected]",
"sender": "[email protected]",
"tags": [
"webhook-example"
],
"opens": [
],
"clicks": [
],
"state": "rejected",
"metadata": {
"user_id": 111
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa8",
"_version": "exampleaaaaaaaaaaaaaaa"
},
"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa8",
"ts": 1384954004
}
]
Copy link

ghost commented Jul 4, 2018

It might be worth noting that events can also be like

[
	{
		"event": "open",
		"ts": 1530486034,
		"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
		"user_agent_parsed": {
			"type": "Other",
			"ua_family": "Gmail image proxy",
			"ua_name": "Gmail image proxy",
			"ua_version": null,
			"ua_url": "http://gmailblog.blogspot.cz/2013/12/images-now-showing.html",
			"ua_company": "Google Inc.",
			"ua_company_url": "http://www.google.com/",
			"ua_icon": "http://cdn.mandrill.com/img/email-client-icons/feedfetcher-google.png",
			"os_family": "Linux",
			"os_name": "Linux",
			"os_url": "http://en.wikipedia.org/wiki/Linux",
			"os_company": null,
			"os_company_url": null,
			"os_icon": "http://cdn.mandrill.com/img/email-client-icons/linux.png",
			"mobile": false
		},
		"ip": "127.0.0.1",
		"location": {
			"country_short": "US",
			"country": "United States",
			"region": "Oklahoma",
			"city": "Oklahoma City",
			"latitude": 35.4675598145,
			"longitude": -97.5164337158,
			"postal_code": "73101",
			"timezone": "-05:00"
		},
		"_id": "exampleaaaaaaaaaaaaaaaaaaaaaaaaaa",
		"msg": {
			"tags": [],
			"sender": null,
			"template": null
		}
	}
]

where this was opened buy gmail bot or any other emailing system, mandrill knows this but still send the event without the state or ts and other important fields.

@covard
Copy link

covard commented May 21, 2020

thank you for this, they don't have any example in their documentations. Was looking all over for this.

@BonnieSilentPartner
Copy link

Agreed! This was so helpful!!

Do you have sample data for the Sync events - AllowList and DenyList?

Thanks!
Bonnie

@ramonsmits
Copy link
Author

@BonnieSilentPartner I'm not using the service anymore. Surprising that 10 years later this is still useful :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment