Mixmax Webhook Event structure
With Mixmax Webhooks, the webhook payload is sent in a JSON format. Each type of event that is sent by Mixmax will have a different structure. Example events are as follows:
Sent
{ "userId": "T3STUS3R1D", "to": [ { "email": "engtestuser3@mixmax.com", "name": "Test User3" } ], "cc": [], "bcc": [], "from": { "email": "engtestuser2@mixmax.com", "name": "Test User2" }, "subject": "Please join me ", "sent": 1481745125403, "id": "16ac8cc837d1b304", "threadId": "16008541212e8a32", "rfc822Id": "<CAHfzPxo09WCKrtyPRM9g+60za4+0cHffwyT0vf867Pp=ehrfQ@mail.gmail.com>", "receivedBy": { "email": "engtestuser2@mixmax.com", "name": "Test User2" }, "plaintextBody": "Please join me for a meeting. \n--\nEngineering Test", "eventName": "message:sent" }
Received
{ "userId": "T3STUS3R1D", "to": [ { "email": "engtestuser2@mixmax.com", "name": "Test User2" } ], "cc": [], "bcc": [], "from": { "email": "engtestuser3@mixmax.com", "name": "Test User3" }, "subject": "Re: Please join me ", "sent": 1481745135403, "id": "16ac8cc837d1b304", "threadId": "16008541212e8a32", "rfc822Id": "<CAHfzPxo09WCKrtyPRM9g+60z9d+0cHffwyT0vf867Pp=ehrfQ@mail.gmail.com>", "receivedBy": { "email": "engtestuser2@mixmax.com", "name": "Test User2" }, "eventName": "message:received" }
Opened
{ "message": { "to": [ { "name": "Test User3", "email": "engtestuser3@mixmax.com" } ], "cc": [], "bcc": [], "subject": "Please join me " }, "userId": "T3STUS3R1D", "messageId": "VyfSqbL195O0z8VK6L", "recipientEmail": "engtestuser3@mixmax.com", "recipientName": "Test User3", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/600.8.9 (KHTML, like Gecko)", "timestamp": 1481746916300, "ipAddress": "::ffff:127.0.0.1", "eventName": "opened" }
Clicked
{ "message": { "to": [ { "name": "Test User2", "email": "engtestuser2@mixmax.com" } ], "cc": [], "bcc": [], "subject": "A link for you" }, "userId": "T3STUS3R1D", "messageId": "OsQNJX4bY95SauarLt", "recipientEmail": "engtestuser2@mixmax.com", "recipientName": "Test User2", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko)", "timestamp": 1481747320985, "linkUrl": "http://www.nytimes.com/", "linkText": "Breaking News, World News & Multimedia", "eventName": "clicked" }
Downloaded
{ "message": { "to": [ { "name": "Test User2", "email": "engtestuser2@mixmax.com" } ], "cc": [], "bcc": [], "subject": "A file for you" }, "userId": "T3STUS3R1D", "messageId": "OsQNJX4bY95SauarLt", "recipientEmail": "engtestuser2@mixmax.com", "recipientName": "Test User2", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko)", "timestamp": 1481747490272, "fileName": "flame (3) (2) (1).svg", "eventName": "downloaded" }
Poll voted on
{ "poll": { "_id": "1ce32901cb476823f3296db6", "pollId": "feCgCLIPsQQxwiXV", "createdAt": 1481747277844, "userId": "T3STUS3R1D", "question": "Example poll", "options": [ { "text": "Option 1" }, { "text": "Option 2" } ] }, "respondent": { "name": "Test User2", "email": "engtestuser2@mixmax.com", "ipAddress": "::ffff:127.0.0.1", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko)", "respondedAt": 1481747716249 }, "vote": "Option 1", "timestamp": 1481747716249, "eventName": "poll:voted" }
Meeting invitation confirmed
{ "invite": { "title": "Test & Eng: Meeting", "timeslots": [{ "start": "2016-12-14T22:00:00.000Z", "end": "2016-12-14T22:30:00.000Z" }, { "start": "2016-12-14T22:30:00.000Z", "end": "2016-12-14T23:00:00.000Z" }, { "start": "2016-12-14T23:00:00.000Z", "end": "2016-12-14T23:30:00.000Z" }] "timezone": "America/Detroit", "calendarId": "engtestuser9@mixmax.com" }, "organizer": { "email": "engtestuser9@mixmax.com", "name":"Eng Test User 9" }, "guest": { "name": "Test User2", "email": "engtestuser2@mixmax.com", }, "selectedTimeslot": "2", "timestamp": 1481747910753, "eventName": "meetinginvites:confirmed" }