Easy-SMTP :: Account - Webhooks

Follow

Event webhooks will notify a URL of your choosing via HTTP POST with information about recipient actions as they occur. You can use this data to track unsubscribes, bounces, opens, and clicks. You can read more about the POSTed data below.

Webhook responses will be handled with one of three patterns:

  • HTTP 200 responses will be considered successful, no retries will occur.
  • HTTP 406 responses will be considered a premanent reject, no retries will occur.
  • All other HTTP responses will be considered a temporary failure and will be retired over a period of 24 hours.


Securing Webhooks

To ensure the autheticity of webhook requests they are signed and the signature is posted along with other webhook parameters:

Parameter Type Description
timestamp int Unix timestamp, i.e. number of seconds passed since Jan. 1, 1970.
token string Random string with a length of 50.
signature string Hexadecimal string generated by HMAC algorithm.

To verify the authenticity of the message, you must do the following:

  • Concatenate the timestamp and token values.
  • Encode the resulting string with the HMAC algorithm using your account id as a key and SHA256 digest mode.
  • Compare the resulting hexdigest to the signature value.

Webhook Parameters

Parameters common to all webhook posts:

Parameter Type Description
email string Recipient email address
timestamp int Unix timestamp, i.e. seconds passed since Jan. 1, 1970
eventType string One of 'Open', 'Click', 'Bounce', or 'Optout
recipientId string The id for the recipient


Parameters common to all OpenClick, and Opt-out webhook posts:

Parameter Type Description
ipAddress string The IP address originating the event.
userAgent string The UserAgent string of the client that originated the event.
eventId string The id for the event.


Parameters common to all Bounce webhook posts:

Parameter Type Description
bounceCode string The evaluated bounce code for the recipient.
Have more questions? Submit a request

Comments

Powered by Zendesk