Skip to navigation
API ReferenceWebhooks

Get the list of all webhooks

Get the list of all webhooks defined for this account

Request

This endpoint expects an object.
keystringRequired
A valid Mandrill API key

Response

Success
idinteger
Unique identifier for the webhook
urlstringformat: "uri"
The URL where webhook events will be posted
eventslist of strings
Array of event types that will trigger the webhook
created_atstringformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+$"

When the webhook was created (UTC YYYY-MM-DD HH:MM:SS.microseconds)

batches_sentinteger
Number of batches sent to this webhook
events_sentinteger
Total number of events sent to this webhook
auth_keystring or nullOptional
The key used for webhook authentication
descriptionstring or nullOptional
Optional description of the webhook
last_sent_atstring or nullOptionalformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

When the last event was sent to this webhook (UTC YYYY-MM-DD HH:MM:SS)

last_errorstring or nullOptional
Last error message received when attempting to call the webhook

Errors

401
Unauthorized Error
500
Internal Server Error