Knowledge Base/Webhooks/Webhooks Basics

Introduction to Webhooks

Kaitlin
posted this on July 19, 2012 12:38 AM

Mandrill's webhooks allow your application to receive information about email events as they occur. You can configure and test webhooks using the Webhooks settings page in your account, or via the API.

Event types

Message event webhooks

Webhooks can be triggered when an email is sent, opened, clicked, etc. Message event webhooks have several types of events:

Event Type Description
Sent message has been sent successfully
Bounced message has hard bounced
Opened recipient opened a message; will only occur when open tracking is enabled
Marked As Spam recipient marked a message as spam
Rejected message was rejected
Delayed message has been sent, but the receiving server has indicated mail is being delivered too quickly and Mandrill should slow down sending temporarily
Soft-Bounced message has soft bounced
Clicked recipient clicked a link in a message; will only occur when click tracking is enabled
Recipient Unsubscribes recipient unsubscribed

Sync event webhooks

Sync webhooks are designed to alow you to sync data to an external data source. They aren't message-based but rather help you track changes to data stored in Mandrill.

Event Type Description
Rejection Blacklist Changes triggered when a Rejection Blacklist entry is added, changed, or removed
Rejection Whitelist Changes triggered when a Rejection Whitelist entry is added or removed

Click for a detailed description of the data format for webhook. Webhooks are batched and POSTed roughly each minute.

Note

Before Mandrill begins POSTing to your webhook URL, it will be verified to ensure it exists.

 
Topic is closed for comments